E1868 remove reports from review mapping controller: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
Line 15: Line 15:
:2. Display and manage different reports
:2. Display and manage different reports
will be segregated into two controllers to handle the individual concerns exclusively. The new design will have
will be segregated into two controllers to handle the individual concerns exclusively. The new design will have
:1. review_mapping_controller to manage the functionality of reviewers.
:1. review_mapping_controller to manage the functionalities of reviewers.
:2. reports_controller to manage the functionality of reports.
:2. reports_controller to handle the reports functionalities.


== Generalize code to display reports ==
== Generalize code to display reports ==

Revision as of 04:50, 14 November 2018

Background

review_mapping_controller is the largest controller in Expertiza with 614 lines of code. The basic functionality of this controller is to assign reviewers to review artefacts or submissions by other participants or teams. But this controller includes a major chunk of code for generating and rendering several reports to the instructors. As part of the project E1837[1], the review_mapping_controller.rb file has been significantly modified to improve maintainability, code quality and code readability. To summarize, the review_mapping_controller was modified by separating the report generation functionality into a new helper named report_formatter_helper. This helper serves the logic for rendering different reports as per the instructor's request, thus segregating the controller specific code from the code for rendering the reports.

Refactoring from E1837 served as one of the primary design improvements to achieve scalability with different reports. But, this improvement contradicts with several Object-Oriented Design Principles. The aim of this project is to extrapolate the report_formatter_helper code into a reports_controller.

Goals

- Separation of concerns
- Generalize code to display reports
- Modify the UI to list the types of reports
- Write tests for the new controller

Separation of Concerns

As part of this refactoring, the existing design of review_mapping_controller which handles two different functionalities namely

1. Manage various reviewers
2. Display and manage different reports

will be segregated into two controllers to handle the individual concerns exclusively. The new design will have

1. review_mapping_controller to manage the functionalities of reviewers.
2. reports_controller to handle the reports functionalities.

Generalize code to display reports

The reports loop through either participants or teams. This loop can be generalized so that the headers, footers, etc. are all the same for all the reports.

Modify the UI to list the types of reports

In the current implementation, the reports are accessed by clicking on the “view review report” button in the buttons tray of an assignment, which leads into the review report page. This page contains a drop-down menu near the top which has the list of reports to navigate to.

The drop-down menu can be replaced by a new ‘...’ icon in the buttons tray, which on hovering on it, would show the menu of various reports.

Write tests for the new controller

Since the logic for report generation has been abstracted into a new controller, existing tests for report generation must be modified and new tests must be written for the new controller.

Implementation specifics

Test Plan

Results

Conclusion