CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding: Difference between revisions
(Created page with "== Introduction == The [http://expertiza.ncsu.edu/ Expertiza] project is a dynamic collaboration between students and faculty at NC State University, built on the Ruby on Rails platform. It serves as a hub for fostering cooperative learning and academic collaboration, offering a suite of tools for efficient course and assignment management. Expertiza empowers instructors with comprehensive control over the learning process, providing insights into various academic face...") |
No edit summary |
||
| Line 1: | Line 1: | ||
== Expertiza == | |||
[http://expertiza.ncsu.edu/ Expertiza] is an open-source web application built on Ruby on Rails that enables instructors to create customized assignments with topic lists for students to choose from. It facilitates team formation, allowing students to collaborate on assignments and projects. Expertiza supports peer review processes where students can provide feedback on each other's submissions across various document formats, including URLs and wiki pages. This freely available platform provides a flexible and comprehensive solution for managing assignments, teamwork, and peer evaluations. | |||
== Introduction == | == Introduction == | ||
We will be improving the UI for bidding view to appear less cluttered. | |||
We're refactoring the assignment_controller.rb in Expertiza, adding a bidding_logic_controller.rb with a seperate method "topic_wise_bidding_teams" enhancing its codebase to adhere to design principles, improving readability, and reducing redundancy. | |||
==Problem Statement== | |||
The reimplementation project entails: | |||
#<b>Refactoring assignment Controller:</b> | |||
File: app/controllers/assignment_controller.rb | |||
Refactor the bidding_details method to a more clear method nameEnhancing code clarity. Separate the bidding logic from the assignment controller to adhere to the Single Responsibility Principle (SRP). | |||
#<b>Improving Bidding View:</b> | |||
< | Files: app/views/assignments/edit/_topics.html.erb , app/views/assignments/n , bidding_details.html.erb | ||
Consolidate the bidding details summary view into a single table for improved clarity and organization. Implement interactive features such as modals or tooltips to provide additional context or information. | |||
#<b>Meaningful Method Names:</b> | |||
Files: app/controllers/assignment_controller.rb , app/models/assignment.rb , app/models/team.rb , app/models/bid.rb | |||
Review existing method names and replace generic or unclear names with descriptive ones that accurately reflect their purpose and functionality ensuring consistency. | |||
#<b>Adherence to Design Principles:</b> | |||
Files: app/controllers/assignment_controller.rb , app/models/assignment.rb , app/models/team.rb , app/models/bid.rb | |||
Refactor code segments to eliminate redundancy and promote code reusability. Stick to the design principles listed below. | |||
== Design Principles == | |||
==== Single Responsibility Principle (SRP): ==== | |||
*Each action in the GradesController will be responsible for a specific task related to managing grades. | |||
*Actions will be refactored to separate concerns such as data retrieval, computation, and view rendering. | |||
*For example, the `view` action will focus solely on retrieving grading data and rendering the grading report. | |||
==== Don't Repeat Yourself (DRY) Principle: ==== | |||
*Code duplication in the GradesController will be eliminated by extracting common functionality into helper methods or modules. | |||
*Repetitive logic, such as retrieving questions or calculating penalties, will be refactored to promote code reusability and maintainability. | |||
==== Dependency Inversion Principle (DIP): ==== | |||
*The GradesController will depend on abstractions, interfaces, or higher-level modules instead of concrete implementations. | |||
*Dependency injection or inversion of control will be used to decouple the controller from specific database or service implementations. | |||
== Team == | == Team == | ||
| Line 22: | Line 50: | ||
*Sai Santhosh Garlapati (sgarlap@ncsu.edu) | *Sai Santhosh Garlapati (sgarlap@ncsu.edu) | ||
*Chinmay Walinjkar (cpwalinj@ncsu.edu) | *Chinmay Walinjkar (cpwalinj@ncsu.edu) | ||
Revision as of 01:35, 9 April 2024
Expertiza
Expertiza is an open-source web application built on Ruby on Rails that enables instructors to create customized assignments with topic lists for students to choose from. It facilitates team formation, allowing students to collaborate on assignments and projects. Expertiza supports peer review processes where students can provide feedback on each other's submissions across various document formats, including URLs and wiki pages. This freely available platform provides a flexible and comprehensive solution for managing assignments, teamwork, and peer evaluations.
Introduction
We will be improving the UI for bidding view to appear less cluttered. We're refactoring the assignment_controller.rb in Expertiza, adding a bidding_logic_controller.rb with a seperate method "topic_wise_bidding_teams" enhancing its codebase to adhere to design principles, improving readability, and reducing redundancy.
Problem Statement
The reimplementation project entails:
- Refactoring assignment Controller:
File: app/controllers/assignment_controller.rb Refactor the bidding_details method to a more clear method nameEnhancing code clarity. Separate the bidding logic from the assignment controller to adhere to the Single Responsibility Principle (SRP).
- Improving Bidding View:
Files: app/views/assignments/edit/_topics.html.erb , app/views/assignments/n , bidding_details.html.erb Consolidate the bidding details summary view into a single table for improved clarity and organization. Implement interactive features such as modals or tooltips to provide additional context or information.
- Meaningful Method Names:
Files: app/controllers/assignment_controller.rb , app/models/assignment.rb , app/models/team.rb , app/models/bid.rb Review existing method names and replace generic or unclear names with descriptive ones that accurately reflect their purpose and functionality ensuring consistency.
- Adherence to Design Principles:
Files: app/controllers/assignment_controller.rb , app/models/assignment.rb , app/models/team.rb , app/models/bid.rb Refactor code segments to eliminate redundancy and promote code reusability. Stick to the design principles listed below.
Design Principles
Single Responsibility Principle (SRP):
- Each action in the GradesController will be responsible for a specific task related to managing grades.
- Actions will be refactored to separate concerns such as data retrieval, computation, and view rendering.
- For example, the `view` action will focus solely on retrieving grading data and rendering the grading report.
Don't Repeat Yourself (DRY) Principle:
- Code duplication in the GradesController will be eliminated by extracting common functionality into helper methods or modules.
- Repetitive logic, such as retrieving questions or calculating penalties, will be refactored to promote code reusability and maintainability.
Dependency Inversion Principle (DIP):
- The GradesController will depend on abstractions, interfaces, or higher-level modules instead of concrete implementations.
- Dependency injection or inversion of control will be used to decouple the controller from specific database or service implementations.
Team
Mentor:
- Anvitha Reddy Gutha (agutha@ncsu.edu)
Members:
- Shiva Vara Prasad Kandhagatla (skandha@ncsu.edu)
- Sai Santhosh Garlapati (sgarlap@ncsu.edu)
- Chinmay Walinjkar (cpwalinj@ncsu.edu)