Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-26T22:51:46Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Addressed Problems==

* '''Controller Complexity:'''
The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
<code>StudentReviewService</code> handles only review-related operations.
<code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
Each class and method has one clear and dedicated purpose.

<syntaxhighlight lang=ruby line> def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end</syntaxhighlight>

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
Shared methods like <code>load_participant_and_assignment</code> promote reuse.
Authorization and locale-setting logic are abstracted into concerns.

<syntaxhighlight lang=ruby line> def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end </syntaxhighlight>

=== Maintainability and Testability ===
* '''Modular Design:'''
Business logic is placed in services to simplify future updates.
Private methods are used to improve unit test isolation.
Clear method names improve code readability.

<syntaxhighlight lang=ruby line> def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end</syntaxhighlight>

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
RESTful routes and actions are followed.
<code>AuthenticationController</code> includes a clear and secure login endpoint.

<syntaxhighlight lang=ruby line> def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end </syntaxhighlight>

=== Localization and Internationalization ===
* '''Locale Handling:'''
Locale is determined from parameters or browser headers.
Rails i18n support is properly configured and applied.

<syntaxhighlight lang=ruby line>def set_locale
I18n.locale = extract_locale || I18n.default_locale
end</syntaxhighlight>

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` was deleted
* Related counters for metareview progress was removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<syntaxhighlight lang=ruby line>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</syntaxhighlight>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<syntaxhighlight lang=ruby line>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end </syntaxhighlight>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<syntaxhighlight lang=ruby line>def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end</syntaxhighlight>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 84.62%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.00%
|-
| <code>app/services/student_review_service.rb</code>
| 84.48%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
Tests sorting logic specific to calibrated assignments:
Uses <code>id % 5</code> criteria.
Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
Ensures <code>review_mappings</code> is set to an empty array.
Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-25T02:17:19Z

Evilkom:

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Addressed Problems==

* '''Controller Complexity:'''
The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
<code>StudentReviewService</code> handles only review-related operations.
<code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
Each class and method has one clear and dedicated purpose.

<syntaxhighlight lang=ruby line> def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end</syntaxhighlight>

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
Shared methods like <code>load_participant_and_assignment</code> promote reuse.
Authorization and locale-setting logic are abstracted into concerns.

<syntaxhighlight lang=ruby line> def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end </syntaxhighlight>

=== Maintainability and Testability ===
* '''Modular Design:'''
Business logic is placed in services to simplify future updates.
Private methods are used to improve unit test isolation.
Clear method names improve code readability.

<syntaxhighlight lang=ruby line> def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end</syntaxhighlight>

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
RESTful routes and actions are followed.
<code>AuthenticationController</code> includes a clear and secure login endpoint.

<syntaxhighlight lang=ruby line> def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end </syntaxhighlight>

=== Localization and Internationalization ===
* '''Locale Handling:'''
Locale is determined from parameters or browser headers.
Rails i18n support is properly configured and applied.

<syntaxhighlight lang=ruby line>def set_locale
I18n.locale = extract_locale || I18n.default_locale
end</syntaxhighlight>

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` was deleted
* Related counters for metareview progress was removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<syntaxhighlight lang=ruby line>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</syntaxhighlight>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<syntaxhighlight lang=ruby line>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end </syntaxhighlight>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<syntaxhighlight lang=ruby line>def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end</syntaxhighlight>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 93.75%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
Tests sorting logic specific to calibrated assignments:
Uses <code>id % 5</code> criteria.
Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
Ensures <code>review_mappings</code> is set to an empty array.
Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-25T02:12:05Z

Evilkom: /* Single Responsibility Principle (SRP) */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Addressed Problems==

* '''Controller Complexity:'''
The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
<code>StudentReviewService</code> handles only review-related operations.
<code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
Each class and method has one clear and dedicated purpose.

<syntaxhighlight lang=ruby line> def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end</syntaxhighlight>

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
Shared methods like <code>load_participant_and_assignment</code> promote reuse.
Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
Business logic is placed in services to simplify future updates.
Private methods are used to improve unit test isolation.
Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
RESTful routes and actions are followed.
<code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
Locale is determined from parameters or browser headers.
Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` was deleted
* Related counters for metareview progress was removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 93.75%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
Tests sorting logic specific to calibrated assignments:
Uses <code>id % 5</code> criteria.
Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
Ensures <code>review_mappings</code> is set to an empty array.
Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-23T02:13:23Z

Evilkom:

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Addressed Problems==

* '''Controller Complexity:'''
The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
<code>StudentReviewService</code> handles only review-related operations.
<code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
Shared methods like <code>load_participant_and_assignment</code> promote reuse.
Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
Business logic is placed in services to simplify future updates.
Private methods are used to improve unit test isolation.
Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
RESTful routes and actions are followed.
<code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
Locale is determined from parameters or browser headers.
Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` was deleted
* Related counters for metareview progress was removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 93.75%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
Tests sorting logic specific to calibrated assignments:
Uses <code>id % 5</code> criteria.
Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
Ensures <code>review_mappings</code> is set to an empty array.
Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-23T02:05:11Z

Evilkom: /* Response Handling */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Addressed Problems==

* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 93.75%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-23T02:04:08Z

Evilkom: /* Design Principles Analysis */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Addressed Problems==

* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 93.75%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-23T01:58:07Z

Evilkom: /* Existing Issues */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Addressed Problems==

* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 93.75%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-23T01:23:51Z

Evilkom:

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==

[[File:controllerdiagram.png]]

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 93.75%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T18:25:39Z

Evilkom: /* Testing Plan */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Test Coverage Summary ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:50:39Z

Evilkom: /* Controller */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:49:22Z

Evilkom: /* Relevant Links */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==

* '''Controller (Original Expertiza Repo):'''
https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb

* '''Views (one controller action view and three partials):'''
https://github.com/expertiza/expertiza/tree/main/app/views/student_review

* '''StudentReviewService Implementation Repo (Kii4ka):'''
https://github.com/Kii4ka/reimplementation-back-end

* '''Pull Request to Expertiza Reimplementation Repo (#197):'''
https://github.com/expertiza/reimplementation-back-end/pull/197

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:41:48Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|none|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:41:25Z

Evilkom:

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|none|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:39:43Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]



{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}



[[File:Ckecks.png|thumb|left|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:38:44Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

[[File:Ckecks.png|thumb|center|600px|All checks have passed]]



== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:37:21Z

Evilkom: /* Testing Plan */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

[[File:Ckecks.png|thumb|left|center|All checks have passed]]

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:36:51Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|center|600px|RSpec Tests Report]]

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

[[File:Ckecks.png|thumb|left|center|All checks have passed]]

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T17:35:55Z

Evilkom:

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
LIST_ACTION = 'list'.freeze
SUBMITTER_ROLE = 'submitter'.freeze

before_action :authorize_user, only: [LIST_ACTION.to_sym]
before_action :load_service, only: [:list]

private

def authorize_user
unless action_allowed?
render json: { error: 'Unauthorized' }, status: :unauthorized
return
end
end

# Quick-exit unless they're a student.
# Then, only allow the LIST_ACTION for users who also have the SUBMITTER_ROLE on this resource.
def action_allowed?
# guard clause: must be a student at all
return false unless current_user_has_student_privileges? # early return

# only permit “list” for submitters
action_name == LIST_ACTION &&
are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE)
end</pre>

=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility. Adding the below code to ApplicationController Class.
<pre>
# 1) Set locale for every request
before_action :set_locale
# 2) Perform authorization
before_action :authorize

private

# Sets I18n.locale based on params, Accept-Language header, or default
def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

# Returns a valid locale symbol or nil
def extract_locale
# 1) Param override
if params[:locale].present?
sym = params[:locale].to_sym
return sym if I18n.available_locales.include?(sym)
end

# 2) Accept-Language header fallback
header = request.env['HTTP_ACCEPT_LANGUAGE'].to_s
header
.split(',')
.map { |l| l[0..1].downcase.to_sym }
.find { |loc| I18n.available_locales.include?(loc) }
end
end
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

[[File:Ckecks.png|thumb|left|600px|All checks have passed]]

______

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

File:Ckecks.png

2025-04-22T17:32:37Z

Evilkom:

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T16:33:13Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

______

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T16:33:01Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T16:32:40Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|left|600px|RSpec Tests Report]]

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T16:31:33Z

Evilkom: /* Test Coverage Summary */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

[[File:Screenshot_2025-04-22_at_12.29.17_PM.png|thumb|center|600px|Screenshot of StudentReviewController test passes]]

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

File:Screenshot 2025-04-22 at 12.29.17 PM.png

2025-04-22T16:30:18Z

Evilkom:

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T16:24:56Z

Evilkom: /* Testing Plan */

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Test Coverage Summary ===

{| class="wikitable"
! File Name
! Test Coverage
|-
| <code>app/controllers/api/v1/student_review_controller.rb</code>
| 86.67%
|-
| <code>app/controllers/application_controller.rb</code>
| 100.0%
|-
| <code>app/services/student_review_service.rb</code>
| 85.71%
|}

== Summary of Tests in StudentReviewController Spec ==

The test file provides comprehensive test coverage for the <code>Api::V1::StudentReviewController</code>. Here's a summary of what was tested:

=== Core Controller Functionality ===
* '''Controller Action Existence:'''
- Verifies that the <code>list</code> action is defined.
* '''Response Structure:'''
- Confirms the controller returns the expected JSON structure with all required fields.
* '''Authorization Logic:'''
- Ensures that proper authorization checks are in place and function correctly.

=== Authorization Tests ===
* '''Proper Authorization:'''
- Tests scenarios where a user is authorized to access resources.
* '''Unauthorized Access:'''
- Ensures unauthorized users receive a 401 response.
* '''Student Privileges:'''
- Tests the <code>action_allowed?</code> method with and without student privileges.
* '''Participant Authorization:'''
- Verifies the <code>authorized_participant?</code> method behavior.

=== Bidding Functionality ===
* '''Bidding Enabled:'''
- Verifies redirection occurs when bidding is enabled.
* '''Bidding Disabled:'''
- Ensures no redirection occurs when bidding is disabled.
* '''<code>check_bidding_redirect</code> Method:'''
- Tests the method independently to verify redirection logic.

=== Service Integration ===
* '''Service Loading:'''
- Tests for proper initialization of the <code>load_service</code> method.
* '''Service Data Usage:'''
- Confirms service output is correctly used in controller responses.

=== Reviewer-related Tests ===
* '''With Reviewer:'''
- Tests the flow when a participant has an associated reviewer.
* '''Without Reviewer:'''
- Tests behavior when no reviewer is present.

=== Special Assignment Types ===
* '''Calibrated Assignments:'''
- Tests functionality related to calibration logic.
* '''Topic ID Handling:'''
- Verifies accurate calculation of <code>topic_id</code>.

=== Internationalization ===
* '''Locale Setting:'''
- Tests <code>controller_locale</code> method functionality.
* '''User Locale Preference:'''
- Tests locale assignment when user has preferences.
* '''Default Locale Fallback:'''
- Ensures fallback to default locale works properly.

=== Edge Cases ===
* '''Missing Reviewer:'''
- Verifies behavior when the reviewer does not exist.
* '''Review Mappings Sorting:'''
- Tests sorting logic for review mappings under various conditions.

This comprehensive test suite ensures that all aspects of the <code>StudentReviewController</code> are thoroughly tested—from basic functionality to edge cases and error handling—achieving a test coverage rate of '''86.67%'''.

== Summary of Tests in ApplicationController Spec ==

The <code>application_controller_spec.rb</code> file provides thorough test coverage for the internationalization (i18n) functionality in the <code>ApplicationController</code>. Here's a summary of what was tested:

=== Locale Setting Logic ===
* '''Set Locale Method:'''
- Tests the <code>set_locale</code> method that configures the application's current locale.
* '''Invalid Locale Handling:'''
- Verifies that invalid locales passed in parameters are properly ignored.
* '''Default Locale Fallback:'''
- Ensures fallback to the default locale when no valid locale is found.

=== Locale Extraction ===
* '''Extract Locale Method:'''
- Tests the <code>extract_locale</code> method for determining the locale to use.
* '''Parameter-based Extraction:'''
- Verifies that the locale is correctly extracted from URL parameters.
* '''HTTP Header Extraction:'''
- Tests extraction of locale from the <code>Accept-Language</code> HTTP header.
* '''Validation:'''
- Confirms extracted locales are checked against <code>I18n.available_locales</code>.

=== HTTP Accept-Language Header Parsing ===
* '''Country-Specific Codes:'''
- Tests proper handling of country-specific language codes such as <code>en-US</code>.
* '''Quality Factors:'''
- Tests parsing of language quality preferences (e.g., <code>fr;q=0.9</code>).
* '''Multiple Languages:'''
- Verifies behavior when the header includes multiple language options.
* '''Invalid Languages:'''
- Ensures that unsupported languages are safely ignored.
* '''Empty/Nil Headers:'''
- Tests how the system behaves when the language header is empty or missing.

=== Edge Cases ===
* '''Multi-part Headers:'''
- Tests parsing of complex <code>Accept-Language</code> headers.
* '''Priority Handling:'''
- Ensures that language preferences are honored based on quality factors.
* '''Fallback Behavior:'''
- Verifies fallback logic when preferred languages are not available.

These tests use RSpec’s controller testing features with an anonymous controller inheriting from <code>ApplicationController</code> to isolate i18n behavior. Setup and teardown logic ensures that the original i18n configuration is restored after each test.

Overall, this test suite ensures robust support for multilingual scenarios, helping maintain internationalization integrity throughout the application.

== Summary of Tests in StudentReviewService Spec ==

The <code>student_review_service_spec.rb</code> file provides comprehensive test coverage for the <code>StudentReviewService</code> class. Here's a breakdown of what was tested:

=== Initialization and Setup ===
* '''Constructor Testing:'''
- Verifies proper initialization, including loading of the participant and assignment.
* '''Topic ID and Review Phase:'''
- Ensures that <code>topic_id</code> and <code>review_phase</code> are set correctly.
* '''Error Handling:'''
- Tests that appropriate exceptions are raised when the participant does not exist.

=== Core Functionality ===
* '''Bidding Enabled Check:'''
- Tests the <code>bidding_enabled?</code> method under both enabled and disabled conditions.
* '''Review Mappings:'''
- Verifies correct loading and sorting of review mappings.
* '''Response IDs:'''
- Confirms that response IDs are correctly extracted from the database.

=== Special Assignment Cases ===
* '''Calibrated Assignments:'''
- Tests sorting logic specific to calibrated assignments:
- Uses <code>id % 5</code> criteria.
- Covers specific IDs (1, 2, 5, 6, 7) to ensure sorting correctness.

=== Edge Cases ===
* '''No Reviewer:'''
- Ensures <code>review_mappings</code> is set to an empty array.
- Verifies that progress counters for reviews are zero.

=== Response Handling ===
* '''Response ID Loading:'''
- Confirms response IDs are correctly retrieved from <code>SampleReview</code>.
* '''Empty Response Lists:'''
- Tests proper handling when no responses are available.

=== Testing Approach ===
This test suite uses RSpec's mocking and stubbing features to isolate logic from external dependencies:
* Uses doubles for models like <code>User</code>, <code>Assignment</code>, and <code>Participant</code>.
* Stubs private methods when needed to focus tests on expected behavior.
* Mocks <code>SampleReview</code> for controlled data input.
* Uses RSpec's expectation syntax to assert correctness.

Overall, this test suite thoroughly validates the <code>StudentReviewService</code> class under both standard and edge-case scenarios, ensuring correct functionality for calibrated assignments, bidding, review progress, and reviewer absence.

== Design Principles Analysis ==

This section outlines how our application aligns with core software design principles, based on a detailed analysis of the <code>StudentReviewService</code>, <code>ApplicationController</code>, and <code>AuthenticationController</code>.

=== Single Responsibility Principle (SRP) ===
* '''Focused Responsibilities:'''
- <code>StudentReviewService</code> handles only review-related operations.
- <code>ApplicationController</code> manages cross-cutting concerns such as authorization and locale setting.
- Each class and method has one clear and dedicated purpose.

def calculate_review_progress
@num_reviews_total = @review_mappings.size
@num_reviews_completed = @review_mappings.count do |map|
!map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
end

=== DRY (Don’t Repeat Yourself) ===
* '''Centralized Logic:'''
- Shared methods like <code>load_participant_and_assignment</code> promote reuse.
- Authorization and locale-setting logic are abstracted into concerns.

def load_participant_and_assignment(participant_id)
@participant = AssignmentParticipant.find(participant_id)
@assignment = @participant.assignment
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)
@review_phase = @assignment.current_stage(@topic_id)
end

=== Maintainability and Testability ===
* '''Modular Design:'''
- Business logic is placed in services to simplify future updates.
- Private methods are used to improve unit test isolation.
- Clear method names improve code readability.

def load_review_mappings
reviewer = @participant.get_reviewer
@review_mappings = reviewer ? ReviewResponseMap.where(...) : []
@review_mappings = @review_mappings.sort_by { |m| m.id % 5 } if @assignment.is_calibrated
end

=== RESTful Best Practices ===
* '''Rails-Conventional Controllers:'''
- RESTful routes and actions are followed.
- <code>AuthenticationController</code> includes a clear and secure login endpoint.

def login
user = User.find_by(name: params[:user_name]) || User.find_by(email: params[:user_name])
if user&.authenticate(params[:password])
token = JsonWebToken.encode({ id: user.id, ... }, 24.hours.from_now)
render json: { token: }, status: :ok
else
render json: { error: 'Invalid username / password' }, status: :unauthorized
end
end

=== Localization and Internationalization ===
* '''Locale Handling:'''
- Locale is determined from parameters or browser headers.
- Rails i18n support is properly configured and applied.

def set_locale
I18n.locale = extract_locale || I18n.default_locale
end

=== Summary Table ===

{| class="wikitable"
! Principle
! Status
! Notes
|-
| '''Single Responsibility'''
| Implemented
| Each class has one focused responsibility
|-
| '''DRY'''
| Implemented
| Shared logic centralized in service methods
|-
| '''Maintainability & Testability'''
| Implemented
| Modular code with helper methods and clear naming
|-
| '''RESTful Practices'''
| Implemented
| Follows Rails conventions
|-
| '''Localization/i18n'''
| Implemented
| Locale handled through params and headers
|}

=== Additional Strengths ===

* '''Service Object Pattern:'''
- Business logic is encapsulated in dedicated service classes, improving modularity and reuse.

* '''JWT Authentication:'''
- Secure authentication is implemented using JSON Web Tokens with proper token generation and expiration handling.

* '''Readable Method Naming:'''
- Method names clearly reflect their responsibilities, enhancing code readability and maintainability.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T07:09:21Z

Evilkom:

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T06:55:00Z

Evilkom: /* Additional Strengths */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T06:53:51Z

Evilkom: /* Summary Table */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T06:52:27Z

Evilkom: /* View Testing */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-22T06:47:44Z

Evilkom: /* Design Principles Applied (Planned) */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-18T20:13:11Z

Evilkom:

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-07T16:28:18Z

Evilkom:

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting (including calibrated assignments)
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

* `controller_locale` method:
* Verify that the locale is correctly set for student users.
* Test fallback behavior if locale cannot be determined.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.
* '''RESTful Best Practices:'''
Routes and controller actions follow Rails conventions
* '''Localization and Internationalization:'''
Support for multiple languages via proper use of the `controller_locale` method and Rails i18n framework.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-07T16:27:02Z

Evilkom: /* Design Principles Applied (Planned) */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting (including calibrated assignments)
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

* `controller_locale` method:
* Verify that the locale is correctly set for student users.
* Test fallback behavior if locale cannot be determined.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.
* '''RESTful Best Practices:'''
Routes and controller actions follow Rails conventions
* '''Localization and Internationalization:'''
Support for multiple languages via proper use of the `controller_locale` method and Rails i18n framework.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-07T14:45:49Z

Evilkom: /* Design Principles Applied (Planned) */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting (including calibrated assignments)
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

* `controller_locale` method:
* Verify that the locale is correctly set for student users.
* Test fallback behavior if locale cannot be determined.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.
* '''RESTful Best Practices:'''
Routes and controller actions follow Rails conventions
* '''Localization and Internationalization:'''
Support for multiple languages via proper use of the `controller_locale` method and Rails i18n framework.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-07T14:44:53Z

Evilkom: /* Controller Testing */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting (including calibrated assignments)
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

* `controller_locale` method:
* Verify that the locale is correctly set for student users.
* Test fallback behavior if locale cannot be determined.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.
* '''RESTful Best Practices:'''
Routes and controller actions follow Rails conventions

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-07T14:44:24Z

Evilkom: /* View Refactoring Plan */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed
* Ensure views follow Rails i18n localization conventions by replacing any hardcoded strings with translation keys where appropriate.

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting (including calibrated assignments)
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.
* '''RESTful Best Practices:'''
Routes and controller actions follow Rails conventions

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-07T14:43:42Z

Evilkom: /* controller_locale Method */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

* Ensure the `controller_locale` method sets the locale appropriately for student users, supporting internationalization and accessibility.

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting (including calibrated assignments)
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.
* '''RESTful Best Practices:'''
Routes and controller actions follow Rails conventions

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-07T14:43:09Z

Evilkom:

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability, following Rails best practices and RESTful conventions.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand
* Adhere to Rails RESTful conventions and best practices.
* Improve maintainability, localization support, and scalability.

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form (to be removed)

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Set locale using controller_locale
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>
=== controller_locale Method ===

Ensure the locale is properly set for student interactions

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting (including calibrated assignments)
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.
* '''RESTful Best Practices:'''
Routes and controller actions follow Rails conventions

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:18:43Z

Evilkom: /* Design / Proposed Solution */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Separation of Concerns ===
This reimplementation is based on a clear separation of responsibilities:
* The controller handles only routing, access validation, and view setup.
* The service object encapsulates all business logic and data handling.
* Obsolete functionality such as `MetareviewResponseMap` is eliminated to simplify the design.

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:16:32Z

Evilkom: /* Controller Diagram */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

===Design Principles Applied (Planned)===
* '''Single Responsibility Principle (SRP):'''
Each component is focused on a distinct task.
* '''DRY (Don't Repeat Yourself):'''
Shared logic is extracted into reusable service methods.
* '''Maintainability and Testability:'''
A modular design makes future updates and testing easier.
* '''Use of Constants:'''
Magic strings are replaced with named constants for clarity.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:15:39Z

Evilkom: /* Architectural Overview */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Architectural Overview ===
The new design will be based on the following structure:
* A `StudentReviewController` that handles only HTTP responsibilities.
* A new `StudentReviewService` that encapsulates all business logic.
* Continued use of models like `AssignmentParticipant`, `Assignment`, and `ReviewResponseMap` (excluding `MetareviewResponseMap`).
* Views adjusted to work with service-driven data.

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:11:42Z

Evilkom: /* Implementation */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Architectural Overview ===
The new design will be based on the following structure:
* A '''lean controller''' focused on HTTP handling (params, redirects, view data)
* A new `StudentReviewService` class that performs all data retrieval and computation
* Simplified views that rely on pre-prepared instance variables

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

==Implementation ==
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:11:18Z

Evilkom: /* Controller Diagram */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Architectural Overview ===
The new design will be based on the following structure:
* A '''lean controller''' focused on HTTP handling (params, redirects, view data)
* A new `StudentReviewService` class that performs all data retrieval and computation
* Simplified views that rely on pre-prepared instance variables

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

===Implementation===
To be added after reimplementation and testing are complete.

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:10:44Z

Evilkom: /* Testing Plan */

==About Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

== Introduction ==
The goal of this project is to reimplement the `StudentReviewController` and its associated views. The reimplementation will introduce a new service layer, streamline logic, and remove obsolete code (e.g., references to metareviews). The new design prioritizes clarity, modularity, and maintainability.

=== Purpose and Scope ===
This reimplementation addresses longstanding design issues in the original controller, including overly complex methods, redundant logic, and tight coupling between controller and view layers.

=== Objectives ===
* Redesign the controller to delegate all business logic to a new service class
* Eliminate obsolete functionality (e.g., metareviews)
* Improve testability by enabling unit tests on the service layer
* Simplify the view templates by preparing data in the controller beforehand

== Requirements ==

Reimplement the `StudentReviewController` and ensure all associated components function correctly. The components involved include:

=== Controller ===
[https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb student_review_controller.rb]

=== Views ===
Located at [https://github.com/expertiza/expertiza/tree/main/app/views/student_review app/views/student_review]:
* `list.html.erb` – main controller view
* `_responses.html.erb` – renders each review
* `_set_dynamic_review.html.erb` – dynamic review form
* `_set_dynamic_metareview.html.erb` – dynamic metareview form

=== Models Used ===
* `AssignmentParticipant`
* `Assignment`
* `SignedUpTeam`
* `ReviewResponseMap`
* `SampleReview`
* `MetareviewResponseMap` (obsolete – all references to be removed)

==Existing Issues==
* '''Controller Complexity:'''
- The `list` method is too long and handles multiple responsibilities: data loading, logic, rendering setup, and redirects.
- Business logic is intertwined with HTTP concerns (e.g., redirection, instance variables).

* '''Redundant Logic:'''
- The `action_allowed?` method checks for student privileges multiple times.

* '''Hard-Coded Values:'''
- Literal strings like `"list"` and `"submitter"` are used instead of constants.

* '''Obsolete Code:'''
- The `MetareviewResponseMap` model is no longer relevant but still referenced.

* '''Lack of Separation of Concerns:'''
- Controller handles business logic that should reside in service/model layers.

== Design / Proposed Solution ==

=== Architectural Overview ===
The new design will be based on the following structure:
* A '''lean controller''' focused on HTTP handling (params, redirects, view data)
* A new `StudentReviewService` class that performs all data retrieval and computation
* Simplified views that rely on pre-prepared instance variables

=== Breakdown of Controller Responsibilities ===
* Validate access using a simplified `action_allowed?` method
* Call `StudentReviewService.new(id, current_user).perform` to gather data
* Assign service output to instance variables for the view
* Redirect if bidding is enabled

=== Breakdown of Service Object Responsibilities ===
* Retrieve `AssignmentParticipant` and associated `Assignment`
* Calculate `topic_id` using `SignedUpTeam.topic_id`
* Determine review phase using `assignment.current_stage`
* Get reviewer via `participant.get_reviewer`
* Load and (if applicable) sort review mappings (`ReviewResponseMap`)
* Count completed and in-progress reviews
* Load sample reviews (`SampleReview`) and extract `response_ids`
* Check if bidding is enabled

=== Removal of Obsolete Code ===
* All logic involving `MetareviewResponseMap` will be deleted
* Related counters for metareview progress will be removed from both controller and views

=== action_allowed? Method ===
* Eliminate redundant privilege check: `|| current_user_has_student_privileges?`
* Use constants instead of literal strings (`LIST_ACTION = 'list'`)
* Restructure logic as:

<pre>
return false unless current_user_has_student_privileges?
return are_needed_authorizations_present?(params[:id], SUBMITTER_ROLE) if action_name == LIST_ACTION
true
</pre>

=== list Method ===
The `list` method will be removed and replaced with a simplified call to the service:

<pre>
def list
return unless valid_participant?
@data = StudentReviewService.new(params[:id], current_user.id).perform
redirect_to bidding_path if @data[:bidding_enabled]
end
</pre>

== View Refactoring Plan ==

* `list.html.erb`: Simplify to only display data passed in from `@data`
* `_responses.html.erb`: Remove inline logic (e.g., topic ID lookups) and rely on passed-in values
* `_set_dynamic_*`: May be removed if dynamic review logic is relocated or rewritten
* View logic for metareviews will be removed

== Testing Plan ==
To ensure the integrity of the reimplementation, both the service objects and controller actions should have dedicated tests. It is recommended to generate test skeletons as soon as the methods are in place.

=== Service Object Testing ===
Thorough unit tests will be added to validate each responsibility of `StudentReviewService`:

'''Key Test Areas:'''
* Participant and assignment lookup
* Topic ID calculation
* Reviewer existence
* Review mapping fetching and sorting
* Completed/in-progress review counts
* Sample review loading and ID extraction
* Bidding check
* Validate that the service object correctly handles all business logic and returns expected outcomes.
* Retrieve the participant using the provided ID.
* Load the associated assignment.
* Calculate topic ID using the participant’s parent ID and user ID.
* Determine the current assignment phase based on the topic ID.
* Check for existence of a reviewer.
* Load correct review mappings based on reviewer existence.
* Sort review mappings correctly for calibrated assignments.
* Count total number of review mappings.
* Count completed reviews by checking submitted responses.
* Calculate number of in-progress reviews.
* Load sample reviews for the assignment.
* Extract and collect response IDs from sample reviews.
* Identify whether bidding is enabled for the assignment.

=== Controller Testing ===
* Verify that the `StudentReviewController` interacts properly with the service object and handles HTTP responses appropriately.

'''Key Test Areas:'''
* `action_allowed?` method:
* Test both cases: when the user has student privileges and when they do not.
* Confirm that `false` is returned when privileges are absent, and that the extra check is done for the `list` action when privileges are present.

* `list` action:
* Ensure controller delegates business logic to the service object.
* Validate correct setting of instance variables based on service output.
* Test redirection to bidding page when bidding is enabled.
* Confirm correct behavior when the current user is unauthorized.

=== View Testing ===
* Test rendering of `list.html.erb` with full and empty review sets
* Validate rendering with various review statuses
* Confirm removal of metareview-related UI elements

== Controller Diagram ==
To be added once the service class and interface are finalized.

== Team ==
'''Mentor'''
* Janice Uwujaren

'''Students'''
* Kenil Patel (kpatel47)
* Smit Patel (spatel68)
* Katerina Vilkomir (evilkom)

== Relevant Links ==
* [https://github.com/expertiza/expertiza/blob/main/app/controllers/student_review_controller.rb/Original Controller Code]
* [https://github.com/expertiza/expertiza/tree/main/app/views/student_review/Student Review Views]
* GitHub Pull Request: (to be added)

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:04:48Z

Evilkom: /* Relevant Links */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:03:27Z

Evilkom: /* Existing Issues */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-04T00:00:07Z

Evilkom: /* Requirements */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-03T23:59:56Z

Evilkom: /* Requirements */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-03T23:58:24Z

Evilkom: /* Introduction */

CSC/ECE 517 Spring 2025 - E2524 Reimplement student review controller

2025-04-03T23:56:34Z

Evilkom: /* About Expertiza */