Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2024

2024-04-24T01:45:59Z

Skandha:

* [[CSC/ECE 517 Spring 2024 - E2401 Implementing and testing import & export controllers]]
* [[CSC/ECE 517 Spring 2024 - E2405 Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2024 - E2407 Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Spring 2024 - E2418. Reimplement of due date.rb]]
* [[CSC/ECE 517 Spring 2024 - E2428 Replicate Roles and Institution UIs ReactJS]]
* [[CSC/ECE 517 Spring 2024 - E2429 Reimplement student_task list]]
* [[CSC/ECE 517 Spring 2024 - E2430 Reimplement student_task view]]
* [[CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding ]]
* [[CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding (Phase 2) ]]
* [[CSC/ECE 517 Spring 2024 - E2414 Grading Audit Trail]]
* [[CSC/ECE 517 Spring 2024 - NTNX-1 : Extend NDB Operator to Support Postgres HA]]
* [[CSC/ECE 517 Spring 2024 - ‬NTNX-2‬‭ : Snapshot Functionality for provisioned databases]]
* [[CSC/ECE 517 Spring 2024 - E2411 : Fix "Back" link on “New Late Policy” page]]
* [[CSC/ECE 517 Spring 2024 - E2416. Reimplement the Question hierarchy]]
* [[CSC/ECE 517 Spring 2024 - E2420. Reimplement student_quizzes_controller]]
* [[CSC/ECE 517 Spring 2024 - E2424. Reimplement the Bookmarks Controller]]
* [[CSC/ECE 517 Spring 2024 - E2426. Create a UI for Assignment Edit page "Etc" tab in ReactJS]]
* [[CSC/ECE 517 Spring 2024 - E2417. Reimplement submitted content controller.rb]]
* [[CSC/ECE 517 Spring 2024 - E2417. Reimplement submitted content controller.rb (Phase 2)]]
* [[CSC/ECE 517 Spring 2024 - E2425. Create a Courses user interface in ReactJS]]
* [[CSC/ECE 517 Spring 2024 - E2431. Reimplement grades/view_team]]
* [[CSC/ECE 517 Spring 2024 - E2404 Refactor student teams functionality]]
* [[CSC/ECE 517 Spring 2024 - E2406 Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management]]
* [[CSC/ECE 517 Spring 2024 - E2421. Reimplement impersonating users (within impersonate controller.rb) - Final Project]]
* [[CSC/ECE 517 Spring 2024 - E2413. Testing - Answer Tagging]]
* [[CSC/ECE 517 Spring 2024 - E2412. Testing for hamer.rb]]
* [[CSC/ECE 517 Spring 2024 - E2427. UI for questionnaire.rb]]
* [[CSC/ECE 517 Spring 2024 - E2419. Reimplement duties controller.rb and badges controller.rb]]
* [[CSC/ECE 517 Spring 2024 - E2432. UI for Participants.rb]]
* [[CSC/ECE 517 Spring 2024 - G2402 Implement REST client, REST API, and Graphql API endpoint for repositories]]
* [[CSC/ECE 517 Spring 2024 - G2400 DevOp for GitHub Miner app]]
* [[CSC/ECE 517 Spring 2024 - E2439 Testing for view_translation_substitutor.rb]]
* [[CSC/ECE 517 Spring 2024 - E2442 Reimplement student task controller]]
* [[CSC/ECE 517 Spring 2024 - E2443 Reimplement grades_controller]]
* [[CSC/ECE 517 Spring 2024 - E2434 Reimplement Frontend for the Grades view]]
* [[CSC/ECE 517 Spring 2024 - E2435 Implement Frontend for the My Profile]]
* [[CSC/ECE 517 Spring 2024 - E2446 Implement Front End for Student Task List]]
* [[CSC/ECE 517 Spring 2024 - E2444 Implement Frontend for the Review]]
* [[CSC/ECE 517 Spring 2024 - E2440 Testing for questionnaire_helper, review_bids_helper]]
* [[CSC/ECE 517 Spring 2024 - E2433 Implement UI for the Student Teams]]
* [[CSC/ECE 517 Spring 2024 - E2415. Reimplement responses controller.rb (Design Document)]]
* [[CSC/ECE 517 Spring 2024 - E2445. Implement BackEnd for participants.rb (Design Document)]]
* [[CSC/ECE 517 Spring 2024 - E2445. Implement BackEnd for participants.rb]]
* [[CSC/ECE 517 Spring 2024 - E2441 Reimplement grades/view_team (Phase 2)]]
* [[CSC/ECE 517 Spring 2024 - E2418. Reimplement of due date.rb (Phase 2)]]

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding (Phase 2)

2024-04-24T01:43:41Z

Skandha: 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..."

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Problem Statement: ==
===Current Problem===
*Instructors using Expertiza lack comprehensive visibility into the bidding process, impeding their ability to discern the most sought-after topics by teams and the prioritization of choices, leading to inefficient allocation of projects.

===Key Deficiencies===
*The absence of essential details, such as which teams have bid on specific topics and the percentage of teams assigning their top-choice projects, results in instructors resorting to cumbersome workarounds, hindering effective management and allocation of projects.

===Proposed Solution===
*Enhancing Expertiza's interface with a dedicated view for instructors to access detailed statistics on topic bids, including priority rankings, team names, total bids, and the percentage of teams selecting each topic as their top choice. This solution aims to streamline workflow, empower instructors with valuable insights, and facilitate fair and efficient project allocation.

== Previous Implementations ==
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/saisanthoshG/expertiza Github Repository]
#[https://github.com/expertiza/expertiza/pull/2795 E2410 Pull Request]
#[https://youtu.be/g9DzKE5otSU Demo Video]

=== Issues With Previous Implementation ===
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Project Goal ==

The goal of this project is to enhance the Expertiza bidding system, making it more intuitive and efficient for both instructors and students. Our primary focus areas include:

*'''Clarity and Visibility:''' We aim to clearly present bidding results, featuring distinct columns for bid priorities and detailed team bid information.

*'''Separation of Concerns:''' Based on prior feedback, the bidding logic will be separated from the assignment controller to improve system maintainability and adhere to the Single Responsibility Principle.

*'''Enhanced Logic and Navigation:''' The project will introduce refined logic for calculating preferred choice percentages to ensure fairness in topic assignments. Additionally, bidding results will be moved to a dedicated page, improving the user experience by providing a focused and intuitive navigation by adding tooltip to show percentage calculation.

The UI/UX will be redesigned to minimize clutter, ensuring that information is visible only when necessary and enhancing the overall usability of the interface.

By achieving these objectives, we intend to significantly improve the bidding system in Expertiza, ensuring it is a more effective tool for educational environments.

== Design ==

The enhanced workflow in Expertiza enables instructors to manage and review student topic bids efficiently. With the new implementation, instructors visit the Assignments page, select an assignment, and activate the Topics tab to manage topics and enable bidding. A newly added "Show bids by priority" button takes users to a comprehensive bidding summary view. This view categorizes and displays detailed bid information, such as the number and percentage of first-choice bids, offering a clear visualization of students' preferences and facilitating fairer topic assignments.

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagramb.jpeg|frameless|upright=3]]

* Instructors can activate topic bidding with a single checkbox.
* The "Show bids by priority" button leads to a detailed summary view.
* Bids are categorized by priority, displaying #1, #2, and #3 bids.
* The percentage of first-choice bids is clearly presented.
* Bidding teams are listed for complete transparency.

=== Current Flow ===

* Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

* Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

* Now go to Topics section and click "Show bids by priority" button.
[[File:Topics_bid_button.jpg|frameless|upright=3]]

* Here you will be able to view various stats of the bidding,like the topics with their IDs, their respective topic names, number of teams that have put that specific topic as their 1st 2nd and 3rd priority bid, along with the names of those teams, the total number of bids and finally the percentage of teams that put the specific topic as their first bid. We can also see the tooltip for the calculation of the percentages when we hover over the percentages.
[[File:Tooltip.png|frameless|upright=3]]

=== Flow of the Bidding Process ===
* The instructor logs in to Expertiza with instructor credentials.
* They navigate to the Assignments page.
* An assignment is selected from the list and opened for editing.
* The instructor checks the "Has Topics" checkbox to activate the Topics tab.
* The Topics tab is then accessed to add a new topic.
* A new topic is created by filling out the new topic form and submitting it.
* This action updates the topic list, and students can begin bidding, assigning their 1st, 2nd, and 3rd priorities to topics.
* To view the bidding details, the instructor clicks the "Show bids by priority" button on the topics page.

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
====1. Display bidding summary based on priority details ====
==== [https://github.com/expertiza/expertiza/commit/92a7f87eaa07853678c0c922ce147a5e71c20661 Method for bidding analysis] ====
File : <code> app/controllers/lottery_controller.rb </code>

Functionality:

* Added `calculate_bidding_summary_based_on_priority` method to `lottery_controller` for aggregating bid data per topic.
* Prepares data for displaying the bidding details for each topic within an assignment.
* It calculates the number of bids for each priority (1, 2, 3) per topic and also computes
* The overall percentages of teams that received their first, second, and third choice.
* This method is responsible for calculating the bidding table data for an assignment.
* Computes the count of assigned teams for each priority level (1, 2, 3) across all topics.
* It checks each team associated with a topic and determines if the team's bid matches

[[File:Lottery_controller.jpeg|frameless|upright=3]]

===2. Background Color according to percentage===
====[https://github.com/expertiza/expertiza/commit/f111f8cc4edd9ebb904237fad185ab86eb4a4a86 Method for background color] ====

File : <code> app/helpers/lottery_helper.rb </code>

Functionality:
* Light red for low percentages
* Light orange for medium percentages
* Light green for high percentages
* No background if outside range
[[File:2_color.jpg|frameless|upright=3]]

===3. Button to show bids by priority===
==== [https://github.com/expertiza/expertiza/commit/11f7b788f6f8bca8dbbfb9477873db07823fc8e9 Button view] ====
File : <code> app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Button to visit the seperate page to view the results of bidding
[[File:3_button.jpg|frameless|upright=3]]

===4. Bidding Summary Table ===
==== [https://github.com/expertiza/expertiza/commit/b798b78c8c6b649caa139044635b05ecd446a62e Summary Table] ====
File : <code> app/views/lottery/calculate_bidding_summary_based_on_priority.html.erb </code>

Functionality:

* View topics with their IDs,
* View topic names
* View number of teams that have bid on that specific topic as their 1st 2nd and 3rd priority bid,
* View the names of those teams
* View the total number of bids and finally the percentage of teams that put the specific topic as their first bid.
* View the percentage of first bids with tooltip and custom background
[[File:App-models-bid.rb.jpg|frameless|upright=3]]

== Accomplishment ==
Our recent project milestones have successfully optimized the topic bidding system in Expertiza. These enhancements focus on improving the instructor's user experience and providing comprehensive insights into student preferences during the topic selection process. The new features not only simplify the instructors' interaction with the system but also bring to light the trending topics that resonate most with students.

[[File:Topics_bid_button.jpg|frameless|upright=3]]

In this updated interface, instructors now have the ability to enable topic bidding with a simple checkbox selection, adding efficiency to the setup process. The interface also introduces a new button, "Show bids by priority," which serves as a gateway to a more detailed bid analysis. This new feature simplifies the instructor's oversight of the bidding process, consolidating all the necessary information in one place and enabling quick adjustments to topics based on student interest.

[[File:Tooltip.png|frameless|upright=3]]

Here, instructors can view the entire landscape of student bids in an organized and informative manner. The page lists topics alongside detailed bid data, such as the number of first, second, and third priority bids, total bids, and the teams that have placed those bids. It also features a calculated percentage of first-choice bids for each topic, providing immediate insight into student preferences. A tooltip offers a quick reference for understanding the calculation behind these percentages, ensuring transparency. This visualization tool allows instructors to discern which topics are trending and which may require additional promotion or reevaluation, streamlining the decision-making process without the need to switch between different views.

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The lottery_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

*'''Test for the method calculate_bidding_summary_based_on_priority in lottery_controller:'''
The test verifies that the calculate_bidding_summary_based_on_priority method accurately computes and returns a structured summary of bids for topics within an assignment, detailing the number of first, second, and third priority bids, total bids, the percentage of first priority bids, and the teams bidding on each topic.
<pre>describe '#calculate_bidding_summary_based_on_priority' do
it 'calculates and returns bidding summary data for topics' do
# Setup test data
assignment = create(:assignment)
topic = create(:topic, assignment: assignment)
team = create(:team, assignment: assignment)
bid = create(:bid, topic: topic, team: team, priority: 1)
team_name = create(:team_name, team: team)

allow(Assignment).to receive(:find).with(assignment.id).and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([topic])
allow(topic).to receive_message_chain(:bids, :includes).and_return([bid])
allow(bid).to receive_message_chain(:team, :name).and_return(team_name)

# Mock params
params = { id: assignment.id }
allow(controller).to receive(:params).and_return(params)

# Expected data structure from calculate_bidding_summary_based_on_priority
expected_topic_data = [
{
id: topic.id,
name: topic.topic_name,
first_bids: 1,
second_bids: 0,
third_bids: 0,
total_bids: 1,
percentage_first: 100.0,
bidding_teams: [team_name]
}
]

# Call the method
controller.instance_variable_set(:@assignment, assignment)
expect(controller.calculate_bidding_summary_based_on_priority).to eq(expected_topic_data)
end
end
</pre>

The given test case, #calculate_bidding_summary_based_on_priority, is designed to verify the correct calculation and return of bidding summary data for topics within an assignment. It tests the scenario where a team has placed a bid with the highest priority on a topic. The setup involves creating mock instances of an assignment, a topic under that assignment, a team assigned to the topic, and a bid indicating the team's priority. The test confirms that the method accurately computes the total number of bids and the percentage of first-choice bids, and it ensures that the team's name is correctly associated with the bid in the summary. This case is crucial for the test plan as it ensures that the bidding summary accurately reflects student preferences and priorities in the bidding process, which is integral to the fair assignment of topics.

*'''Test for background color helper method:'''
The test suite for LotteryHelper#background_color_by_percentage method checks that it returns appropriate CSS background colors for low, medium, and high percentage values, and defaults to no background when the percentage is out of the 0-100% range.
<pre>

# Assuming your helper module is in the helpers folder
RSpec.describe LotteryHelper, type: :helper do
# Test for low percentage range
describe '#background_color_by_percentage' do
it 'returns light red for low percentages' do
expect(helper.background_color_by_percentage(10)).to eq('background-color: #ffcccc;')
end

# Test for medium percentage range
it 'returns light orange for medium percentages' do
expect(helper.background_color_by_percentage(50)).to eq('background-color: #ffcc99;')
end

# Test for high percentage range
it 'returns light green for high percentages' do
expect(helper.background_color_by_percentage(80)).to eq('background-color: #ccffcc;')
end

# Test for percentage out of range
it 'returns no background for percentages out of range' do
expect(helper.background_color_by_percentage(101)).to eq('background-color: none;')
expect(helper.background_color_by_percentage(-1)).to eq('background-color: none;')
end
end
end
</pre>

The test suite for the `LotteryHelper` module’s `#background_color_by_percentage` method ensures that the UI consistently displays the correct color codes for varying percentage ranges. It confirms that percentages within defined thresholds are mapped to specific background colors: light red for low, light orange for medium, and light green for high values. Additionally, it tests the method's response to percentages outside the 0-100% range, expecting no background color to be applied, thereby validating the method’s reliability in handling edge cases. This is a critical part of our test plan to ensure visual consistency and user-friendly feedback within the application.

== Demo Video ==
You can watch this [https://youtu.be/g9DzKE5otSU Demonstration Video]for a detailed demonstration of the project.

== 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)

===References===
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T01:35:39Z

Skandha: /* New functions that are implemented */

File:Lottery controller.jpeg

2024-04-24T01:34:38Z

Skandha:

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T01:26:25Z

Skandha: /* RSpec Testing */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Problem Statement: ==
===Current Problem===
*Instructors using Expertiza lack comprehensive visibility into the bidding process, impeding their ability to discern the most sought-after topics by teams and the prioritization of choices, leading to inefficient allocation of projects.

===Key Deficiencies===
*The absence of essential details, such as which teams have bid on specific topics and the percentage of teams assigning their top-choice projects, results in instructors resorting to cumbersome workarounds, hindering effective management and allocation of projects.

===Proposed Solution===
*Enhancing Expertiza's interface with a dedicated view for instructors to access detailed statistics on topic bids, including priority rankings, team names, total bids, and the percentage of teams selecting each topic as their top choice. This solution aims to streamline workflow, empower instructors with valuable insights, and facilitate fair and efficient project allocation.

== Previous Implementations ==
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/saisanthoshG/expertiza Github Repository]
#[https://github.com/expertiza/expertiza/pull/2795 E2410 Pull Request]
#[https://youtu.be/g9DzKE5otSU Demo Video]

=== Issues With Previous Implementation ===
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Project Goal ==

The goal of this project is to enhance the Expertiza bidding system, making it more intuitive and efficient for both instructors and students. Our primary focus areas include:

*'''Clarity and Visibility:''' We aim to clearly present bidding results, featuring distinct columns for bid priorities and detailed team bid information.

*'''Separation of Concerns:''' Based on prior feedback, the bidding logic will be separated from the assignment controller to improve system maintainability and adhere to the Single Responsibility Principle.

*'''Enhanced Logic and Navigation:''' The project will introduce refined logic for calculating preferred choice percentages to ensure fairness in topic assignments. Additionally, bidding results will be moved to a dedicated page, improving the user experience by providing a focused and intuitive navigation by adding tooltip to show percentage calculation.

The UI/UX will be redesigned to minimize clutter, ensuring that information is visible only when necessary and enhancing the overall usability of the interface.

By achieving these objectives, we intend to significantly improve the bidding system in Expertiza, ensuring it is a more effective tool for educational environments.

== Design ==

The enhanced workflow in Expertiza enables instructors to manage and review student topic bids efficiently. With the new implementation, instructors visit the Assignments page, select an assignment, and activate the Topics tab to manage topics and enable bidding. A newly added "Show bids by priority" button takes users to a comprehensive bidding summary view. This view categorizes and displays detailed bid information, such as the number and percentage of first-choice bids, offering a clear visualization of students' preferences and facilitating fairer topic assignments.

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagramb.jpeg|frameless|upright=3]]

* Instructors can activate topic bidding with a single checkbox.
* The "Show bids by priority" button leads to a detailed summary view.
* Bids are categorized by priority, displaying #1, #2, and #3 bids.
* The percentage of first-choice bids is clearly presented.
* Bidding teams are listed for complete transparency.

=== Current Flow ===

* Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

* Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

* Now go to Topics section and click "Show bids by priority" button.
[[File:Topics_bid_button.jpg|frameless|upright=3]]

* Here you will be able to view various stats of the bidding,like the topics with their IDs, their respective topic names, number of teams that have put that specific topic as their 1st 2nd and 3rd priority bid, along with the names of those teams, the total number of bids and finally the percentage of teams that put the specific topic as their first bid. We can also see the tooltip for the calculation of the percentages when we hover over the percentages.
[[File:Tooltip.png|frameless|upright=3]]

=== Flow of the Bidding Process ===
* The instructor logs in to Expertiza with instructor credentials.
* They navigate to the Assignments page.
* An assignment is selected from the list and opened for editing.
* The instructor checks the "Has Topics" checkbox to activate the Topics tab.
* The Topics tab is then accessed to add a new topic.
* A new topic is created by filling out the new topic form and submitting it.
* This action updates the topic list, and students can begin bidding, assigning their 1st, 2nd, and 3rd priorities to topics.
* To view the bidding details, the instructor clicks the "Show bids by priority" button on the topics page.

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
====1. Display bidding summary based on priority details ====
==== [https://github.com/expertiza/expertiza/commit/92a7f87eaa07853678c0c922ce147a5e71c20661 Method for bidding analysis] ====
File : <code> app/controllers/lottery_controller.rb </code>

Functionality:

* Added `calculate_bidding_summary_based_on_priority` method to `lottery_controller` for aggregating bid data per topic.
* Prepares data for displaying the bidding details for each topic within an assignment.
* It calculates the number of bids for each priority (1, 2, 3) per topic and also computes
* The overall percentages of teams that received their first, second, and third choice.
* This method is responsible for calculating the bidding table data for an assignment.
* Computes the count of assigned teams for each priority level (1, 2, 3) across all topics.
* It checks each team associated with a topic and determines if the team's bid matches

[[File:1_lottery_code.jpg|frameless|upright=3]]

===2. Background Color according to percentage===
====[https://github.com/expertiza/expertiza/commit/f111f8cc4edd9ebb904237fad185ab86eb4a4a86 Method for background color] ====

File : <code> app/helpers/lottery_helper.rb </code>

Functionality:
* Light red for low percentages
* Light orange for medium percentages
* Light green for high percentages
* No background if outside range
[[File:2_color.jpg|frameless|upright=3]]

===3. Button to show bids by priority===
==== [https://github.com/expertiza/expertiza/commit/11f7b788f6f8bca8dbbfb9477873db07823fc8e9 Button view] ====
File : <code> app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Button to visit the seperate page to view the results of bidding
[[File:3_button.jpg|frameless|upright=3]]

===4. Bidding Summary Table ===
==== [https://github.com/expertiza/expertiza/commit/b798b78c8c6b649caa139044635b05ecd446a62e Summary Table] ====
File : <code> app/views/lottery/calculate_bidding_summary_based_on_priority.html.erb </code>

Functionality:

* View topics with their IDs,
* View topic names
* View number of teams that have bid on that specific topic as their 1st 2nd and 3rd priority bid,
* View the names of those teams
* View the total number of bids and finally the percentage of teams that put the specific topic as their first bid.
* View the percentage of first bids with tooltip and custom background
[[File:App-models-bid.rb.jpg|frameless|upright=3]]

== Accomplishment ==
Our recent project milestones have successfully optimized the topic bidding system in Expertiza. These enhancements focus on improving the instructor's user experience and providing comprehensive insights into student preferences during the topic selection process. The new features not only simplify the instructors' interaction with the system but also bring to light the trending topics that resonate most with students.

[[File:Topics_bid_button.jpg|frameless|upright=3]]

In this updated interface, instructors now have the ability to enable topic bidding with a simple checkbox selection, adding efficiency to the setup process. The interface also introduces a new button, "Show bids by priority," which serves as a gateway to a more detailed bid analysis. This new feature simplifies the instructor's oversight of the bidding process, consolidating all the necessary information in one place and enabling quick adjustments to topics based on student interest.

[[File:Tooltip.png|frameless|upright=3]]

Here, instructors can view the entire landscape of student bids in an organized and informative manner. The page lists topics alongside detailed bid data, such as the number of first, second, and third priority bids, total bids, and the teams that have placed those bids. It also features a calculated percentage of first-choice bids for each topic, providing immediate insight into student preferences. A tooltip offers a quick reference for understanding the calculation behind these percentages, ensuring transparency. This visualization tool allows instructors to discern which topics are trending and which may require additional promotion or reevaluation, streamlining the decision-making process without the need to switch between different views.

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The lottery_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

*'''Test for the method calculate_bidding_summary_based_on_priority in lottery_controller:'''
The test verifies that the calculate_bidding_summary_based_on_priority method accurately computes and returns a structured summary of bids for topics within an assignment, detailing the number of first, second, and third priority bids, total bids, the percentage of first priority bids, and the teams bidding on each topic.
<pre>describe '#calculate_bidding_summary_based_on_priority' do
it 'calculates and returns bidding summary data for topics' do
# Setup test data
assignment = create(:assignment)
topic = create(:topic, assignment: assignment)
team = create(:team, assignment: assignment)
bid = create(:bid, topic: topic, team: team, priority: 1)
team_name = create(:team_name, team: team)

allow(Assignment).to receive(:find).with(assignment.id).and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([topic])
allow(topic).to receive_message_chain(:bids, :includes).and_return([bid])
allow(bid).to receive_message_chain(:team, :name).and_return(team_name)

# Mock params
params = { id: assignment.id }
allow(controller).to receive(:params).and_return(params)

# Expected data structure from calculate_bidding_summary_based_on_priority
expected_topic_data = [
{
id: topic.id,
name: topic.topic_name,
first_bids: 1,
second_bids: 0,
third_bids: 0,
total_bids: 1,
percentage_first: 100.0,
bidding_teams: [team_name]
}
]

# Call the method
controller.instance_variable_set(:@assignment, assignment)
expect(controller.calculate_bidding_summary_based_on_priority).to eq(expected_topic_data)
end
end
</pre>

The given test case, #calculate_bidding_summary_based_on_priority, is designed to verify the correct calculation and return of bidding summary data for topics within an assignment. It tests the scenario where a team has placed a bid with the highest priority on a topic. The setup involves creating mock instances of an assignment, a topic under that assignment, a team assigned to the topic, and a bid indicating the team's priority. The test confirms that the method accurately computes the total number of bids and the percentage of first-choice bids, and it ensures that the team's name is correctly associated with the bid in the summary. This case is crucial for the test plan as it ensures that the bidding summary accurately reflects student preferences and priorities in the bidding process, which is integral to the fair assignment of topics.

*'''Test for background color helper method:'''
The test suite for LotteryHelper#background_color_by_percentage method checks that it returns appropriate CSS background colors for low, medium, and high percentage values, and defaults to no background when the percentage is out of the 0-100% range.
<pre>

# Assuming your helper module is in the helpers folder
RSpec.describe LotteryHelper, type: :helper do
# Test for low percentage range
describe '#background_color_by_percentage' do
it 'returns light red for low percentages' do
expect(helper.background_color_by_percentage(10)).to eq('background-color: #ffcccc;')
end

# Test for medium percentage range
it 'returns light orange for medium percentages' do
expect(helper.background_color_by_percentage(50)).to eq('background-color: #ffcc99;')
end

# Test for high percentage range
it 'returns light green for high percentages' do
expect(helper.background_color_by_percentage(80)).to eq('background-color: #ccffcc;')
end

# Test for percentage out of range
it 'returns no background for percentages out of range' do
expect(helper.background_color_by_percentage(101)).to eq('background-color: none;')
expect(helper.background_color_by_percentage(-1)).to eq('background-color: none;')
end
end
end
</pre>

The test suite for the `LotteryHelper` module’s `#background_color_by_percentage` method ensures that the UI consistently displays the correct color codes for varying percentage ranges. It confirms that percentages within defined thresholds are mapped to specific background colors: light red for low, light orange for medium, and light green for high values. Additionally, it tests the method's response to percentages outside the 0-100% range, expecting no background color to be applied, thereby validating the method’s reliability in handling edge cases. This is a critical part of our test plan to ensure visual consistency and user-friendly feedback within the application.

== Demo Video ==
You can watch this [https://youtu.be/g9DzKE5otSU Demonstration Video]for a detailed demonstration of the project.

== 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)

===References===
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T01:16:46Z

Skandha: /* RSpec Testing */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Problem Statement: ==
===Current Problem===
*Instructors using Expertiza lack comprehensive visibility into the bidding process, impeding their ability to discern the most sought-after topics by teams and the prioritization of choices, leading to inefficient allocation of projects.

===Key Deficiencies===
*The absence of essential details, such as which teams have bid on specific topics and the percentage of teams assigning their top-choice projects, results in instructors resorting to cumbersome workarounds, hindering effective management and allocation of projects.

===Proposed Solution===
*Enhancing Expertiza's interface with a dedicated view for instructors to access detailed statistics on topic bids, including priority rankings, team names, total bids, and the percentage of teams selecting each topic as their top choice. This solution aims to streamline workflow, empower instructors with valuable insights, and facilitate fair and efficient project allocation.

== Previous Implementations ==
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/saisanthoshG/expertiza Github Repository]
#[https://github.com/expertiza/expertiza/pull/2795 E2410 Pull Request]
#[https://youtu.be/g9DzKE5otSU Demo Video]

=== Issues With Previous Implementation ===
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Project Goal ==

The goal of this project is to enhance the Expertiza bidding system, making it more intuitive and efficient for both instructors and students. Our primary focus areas include:

*'''Clarity and Visibility:''' We aim to clearly present bidding results, featuring distinct columns for bid priorities and detailed team bid information.

*'''Separation of Concerns:''' Based on prior feedback, the bidding logic will be separated from the assignment controller to improve system maintainability and adhere to the Single Responsibility Principle.

*'''Enhanced Logic and Navigation:''' The project will introduce refined logic for calculating preferred choice percentages to ensure fairness in topic assignments. Additionally, bidding results will be moved to a dedicated page, improving the user experience by providing a focused and intuitive navigation by adding tooltip to show percentage calculation.

The UI/UX will be redesigned to minimize clutter, ensuring that information is visible only when necessary and enhancing the overall usability of the interface.

By achieving these objectives, we intend to significantly improve the bidding system in Expertiza, ensuring it is a more effective tool for educational environments.

== Design ==

The enhanced workflow in Expertiza enables instructors to manage and review student topic bids efficiently. With the new implementation, instructors visit the Assignments page, select an assignment, and activate the Topics tab to manage topics and enable bidding. A newly added "Show bids by priority" button takes users to a comprehensive bidding summary view. This view categorizes and displays detailed bid information, such as the number and percentage of first-choice bids, offering a clear visualization of students' preferences and facilitating fairer topic assignments.

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagramb.jpeg|frameless|upright=3]]

* Instructors can activate topic bidding with a single checkbox.
* The "Show bids by priority" button leads to a detailed summary view.
* Bids are categorized by priority, displaying #1, #2, and #3 bids.
* The percentage of first-choice bids is clearly presented.
* Bidding teams are listed for complete transparency.

=== Current Flow ===

* Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

* Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

* Now go to Topics section and click "Show bids by priority" button.
[[File:Topics_bid_button.jpg|frameless|upright=3]]

* Here you will be able to view various stats of the bidding,like the topics with their IDs, their respective topic names, number of teams that have put that specific topic as their 1st 2nd and 3rd priority bid, along with the names of those teams, the total number of bids and finally the percentage of teams that put the specific topic as their first bid. We can also see the tooltip for the calculation of the percentages when we hover over the percentages.
[[File:Tooltip.png|frameless|upright=3]]

=== Flow of the Bidding Process ===
* The instructor logs in to Expertiza with instructor credentials.
* They navigate to the Assignments page.
* An assignment is selected from the list and opened for editing.
* The instructor checks the "Has Topics" checkbox to activate the Topics tab.
* The Topics tab is then accessed to add a new topic.
* A new topic is created by filling out the new topic form and submitting it.
* This action updates the topic list, and students can begin bidding, assigning their 1st, 2nd, and 3rd priorities to topics.
* To view the bidding details, the instructor clicks the "Show bids by priority" button on the topics page.

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
====1. Display bidding summary based on priority details ====
==== [https://github.com/expertiza/expertiza/commit/92a7f87eaa07853678c0c922ce147a5e71c20661 Method for bidding analysis] ====
File : <code> app/controllers/lottery_controller.rb </code>

Functionality:

* Added `calculate_bidding_summary_based_on_priority` method to `lottery_controller` for aggregating bid data per topic.
* Prepares data for displaying the bidding details for each topic within an assignment.
* It calculates the number of bids for each priority (1, 2, 3) per topic and also computes
* The overall percentages of teams that received their first, second, and third choice.
* This method is responsible for calculating the bidding table data for an assignment.
* Computes the count of assigned teams for each priority level (1, 2, 3) across all topics.
* It checks each team associated with a topic and determines if the team's bid matches

[[File:1_lottery_code.jpg|frameless|upright=3]]

===2. Background Color according to percentage===
====[https://github.com/expertiza/expertiza/commit/f111f8cc4edd9ebb904237fad185ab86eb4a4a86 Method for background color] ====

File : <code> app/helpers/lottery_helper.rb </code>

Functionality:
* Light red for low percentages
* Light orange for medium percentages
* Light green for high percentages
* No background if outside range
[[File:2_color.jpg|frameless|upright=3]]

===3. Button to show bids by priority===
==== [https://github.com/expertiza/expertiza/commit/11f7b788f6f8bca8dbbfb9477873db07823fc8e9 Button view] ====
File : <code> app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Button to visit the seperate page to view the results of bidding
[[File:3_button.jpg|frameless|upright=3]]

===4. Bidding Summary Table ===
==== [https://github.com/expertiza/expertiza/commit/b798b78c8c6b649caa139044635b05ecd446a62e Summary Table] ====
File : <code> app/views/lottery/calculate_bidding_summary_based_on_priority.html.erb </code>

Functionality:

* View topics with their IDs,
* View topic names
* View number of teams that have bid on that specific topic as their 1st 2nd and 3rd priority bid,
* View the names of those teams
* View the total number of bids and finally the percentage of teams that put the specific topic as their first bid.
* View the percentage of first bids with tooltip and custom background
[[File:App-models-bid.rb.jpg|frameless|upright=3]]

== Accomplishment ==
Our recent project milestones have successfully optimized the topic bidding system in Expertiza. These enhancements focus on improving the instructor's user experience and providing comprehensive insights into student preferences during the topic selection process. The new features not only simplify the instructors' interaction with the system but also bring to light the trending topics that resonate most with students.

[[File:Topics_bid_button.jpg|frameless|upright=3]]

In this updated interface, instructors now have the ability to enable topic bidding with a simple checkbox selection, adding efficiency to the setup process. The interface also introduces a new button, "Show bids by priority," which serves as a gateway to a more detailed bid analysis. This new feature simplifies the instructor's oversight of the bidding process, consolidating all the necessary information in one place and enabling quick adjustments to topics based on student interest.

[[File:Tooltip.png|frameless|upright=3]]

Here, instructors can view the entire landscape of student bids in an organized and informative manner. The page lists topics alongside detailed bid data, such as the number of first, second, and third priority bids, total bids, and the teams that have placed those bids. It also features a calculated percentage of first-choice bids for each topic, providing immediate insight into student preferences. A tooltip offers a quick reference for understanding the calculation behind these percentages, ensuring transparency. This visualization tool allows instructors to discern which topics are trending and which may require additional promotion or reevaluation, streamlining the decision-making process without the need to switch between different views.

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The lottery_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

*'''Test for the method calculate_bidding_summary_based_on_priority in lottery_controller:'''
The test verifies that the calculate_bidding_summary_based_on_priority method accurately computes and returns a structured summary of bids for topics within an assignment, detailing the number of first, second, and third priority bids, total bids, the percentage of first priority bids, and the teams bidding on each topic.
<pre>describe '#calculate_bidding_summary_based_on_priority' do
it 'calculates and returns bidding summary data for topics' do
# Setup test data
assignment = create(:assignment)
topic = create(:topic, assignment: assignment)
team = create(:team, assignment: assignment)
bid = create(:bid, topic: topic, team: team, priority: 1)
team_name = create(:team_name, team: team)

allow(Assignment).to receive(:find).with(assignment.id).and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([topic])
allow(topic).to receive_message_chain(:bids, :includes).and_return([bid])
allow(bid).to receive_message_chain(:team, :name).and_return(team_name)

# Mock params
params = { id: assignment.id }
allow(controller).to receive(:params).and_return(params)

# Expected data structure from calculate_bidding_summary_based_on_priority
expected_topic_data = [
{
id: topic.id,
name: topic.topic_name,
first_bids: 1,
second_bids: 0,
third_bids: 0,
total_bids: 1,
percentage_first: 100.0,
bidding_teams: [team_name]
}
]

# Call the method
controller.instance_variable_set(:@assignment, assignment)
expect(controller.calculate_bidding_summary_based_on_priority).to eq(expected_topic_data)
end
end
</pre>

The given test case, #calculate_bidding_summary_based_on_priority, is designed to verify the correct calculation and return of bidding summary data for topics within an assignment. It tests the scenario where a team has placed a bid with the highest priority on a topic. The setup involves creating mock instances of an assignment, a topic under that assignment, a team assigned to the topic, and a bid indicating the team's priority. The test confirms that the method accurately computes the total number of bids and the percentage of first-choice bids, and it ensures that the team's name is correctly associated with the bid in the summary. This case is crucial for the test plan as it ensures that the bidding summary accurately reflects student preferences and priorities in the bidding process, which is integral to the fair assignment of topics.

*'''Test for background color helper method:'''
The test suite for LotteryHelper#background_color_by_percentage method checks that it returns appropriate CSS background colors for low, medium, and high percentage values, and defaults to no background when the percentage is out of the 0-100% range.
<pre>

# Assuming your helper module is in the helpers folder
RSpec.describe LotteryHelper, type: :helper do
# Test for low percentage range
describe '#background_color_by_percentage' do
it 'returns light red for low percentages' do
expect(helper.background_color_by_percentage(10)).to eq('background-color: #ffcccc;')
end

# Test for medium percentage range
it 'returns light orange for medium percentages' do
expect(helper.background_color_by_percentage(50)).to eq('background-color: #ffcc99;')
end

# Test for high percentage range
it 'returns light green for high percentages' do
expect(helper.background_color_by_percentage(80)).to eq('background-color: #ccffcc;')
end

# Test for percentage out of range
it 'returns no background for percentages out of range' do
expect(helper.background_color_by_percentage(101)).to eq('background-color: none;')
expect(helper.background_color_by_percentage(-1)).to eq('background-color: none;')
end
end
end
</pre>

== Demo Video ==
You can watch this [https://youtu.be/g9DzKE5otSU Demonstration Video]for a detailed demonstration of the project.

== 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)

===References===
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T01:07:51Z

Skandha: /* Accomplishment */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Problem Statement: ==
===Current Problem===
*Instructors using Expertiza lack comprehensive visibility into the bidding process, impeding their ability to discern the most sought-after topics by teams and the prioritization of choices, leading to inefficient allocation of projects.

===Key Deficiencies===
*The absence of essential details, such as which teams have bid on specific topics and the percentage of teams assigning their top-choice projects, results in instructors resorting to cumbersome workarounds, hindering effective management and allocation of projects.

===Proposed Solution===
*Enhancing Expertiza's interface with a dedicated view for instructors to access detailed statistics on topic bids, including priority rankings, team names, total bids, and the percentage of teams selecting each topic as their top choice. This solution aims to streamline workflow, empower instructors with valuable insights, and facilitate fair and efficient project allocation.

== Previous Implementations ==
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/saisanthoshG/expertiza Github Repository]
#[https://github.com/expertiza/expertiza/pull/2795 E2410 Pull Request]
#[https://youtu.be/g9DzKE5otSU Demo Video]

=== Issues With Previous Implementation ===
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Project Goal ==

The goal of this project is to enhance the Expertiza bidding system, making it more intuitive and efficient for both instructors and students. Our primary focus areas include:

*'''Clarity and Visibility:''' We aim to clearly present bidding results, featuring distinct columns for bid priorities and detailed team bid information.

*'''Separation of Concerns:''' Based on prior feedback, the bidding logic will be separated from the assignment controller to improve system maintainability and adhere to the Single Responsibility Principle.

*'''Enhanced Logic and Navigation:''' The project will introduce refined logic for calculating preferred choice percentages to ensure fairness in topic assignments. Additionally, bidding results will be moved to a dedicated page, improving the user experience by providing a focused and intuitive navigation by adding tooltip to show percentage calculation.

The UI/UX will be redesigned to minimize clutter, ensuring that information is visible only when necessary and enhancing the overall usability of the interface.

By achieving these objectives, we intend to significantly improve the bidding system in Expertiza, ensuring it is a more effective tool for educational environments.

== Design ==

The enhanced workflow in Expertiza enables instructors to manage and review student topic bids efficiently. With the new implementation, instructors visit the Assignments page, select an assignment, and activate the Topics tab to manage topics and enable bidding. A newly added "Show bids by priority" button takes users to a comprehensive bidding summary view. This view categorizes and displays detailed bid information, such as the number and percentage of first-choice bids, offering a clear visualization of students' preferences and facilitating fairer topic assignments.

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagramb.jpeg|frameless|upright=3]]

* Instructors can activate topic bidding with a single checkbox.
* The "Show bids by priority" button leads to a detailed summary view.
* Bids are categorized by priority, displaying #1, #2, and #3 bids.
* The percentage of first-choice bids is clearly presented.
* Bidding teams are listed for complete transparency.

=== Current Flow ===

* Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

* Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

* Now go to Topics section and click "Show bids by priority" button.
[[File:Topics_bid_button.jpg|frameless|upright=3]]

* Here you will be able to view various stats of the bidding,like the topics with their IDs, their respective topic names, number of teams that have put that specific topic as their 1st 2nd and 3rd priority bid, along with the names of those teams, the total number of bids and finally the percentage of teams that put the specific topic as their first bid. We can also see the tooltip for the calculation of the percentages when we hover over the percentages.
[[File:Tooltip.png|frameless|upright=3]]

=== Flow of the Bidding Process ===
* The instructor logs in to Expertiza with instructor credentials.
* They navigate to the Assignments page.
* An assignment is selected from the list and opened for editing.
* The instructor checks the "Has Topics" checkbox to activate the Topics tab.
* The Topics tab is then accessed to add a new topic.
* A new topic is created by filling out the new topic form and submitting it.
* This action updates the topic list, and students can begin bidding, assigning their 1st, 2nd, and 3rd priorities to topics.
* To view the bidding details, the instructor clicks the "Show bids by priority" button on the topics page.

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
====1. Display bidding summary based on priority details ====
==== [https://github.com/expertiza/expertiza/commit/92a7f87eaa07853678c0c922ce147a5e71c20661 Method for bidding analysis] ====
File : <code> app/controllers/lottery_controller.rb </code>

Functionality:

* Added `calculate_bidding_summary_based_on_priority` method to `lottery_controller` for aggregating bid data per topic.
* Prepares data for displaying the bidding details for each topic within an assignment.
* It calculates the number of bids for each priority (1, 2, 3) per topic and also computes
* The overall percentages of teams that received their first, second, and third choice.
* This method is responsible for calculating the bidding table data for an assignment.
* Computes the count of assigned teams for each priority level (1, 2, 3) across all topics.
* It checks each team associated with a topic and determines if the team's bid matches

[[File:1_lottery_code.jpg|frameless|upright=3]]

===2. Background Color according to percentage===
====[https://github.com/expertiza/expertiza/commit/f111f8cc4edd9ebb904237fad185ab86eb4a4a86 Method for background color] ====

File : <code> app/helpers/lottery_helper.rb </code>

Functionality:
* Light red for low percentages
* Light orange for medium percentages
* Light green for high percentages
* No background if outside range
[[File:2_color.jpg|frameless|upright=3]]

===3. Button to show bids by priority===
==== [https://github.com/expertiza/expertiza/commit/11f7b788f6f8bca8dbbfb9477873db07823fc8e9 Button view] ====
File : <code> app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Button to visit the seperate page to view the results of bidding
[[File:3_button.jpg|frameless|upright=3]]

===4. Bidding Summary Table ===
==== [https://github.com/expertiza/expertiza/commit/b798b78c8c6b649caa139044635b05ecd446a62e Summary Table] ====
File : <code> app/views/lottery/calculate_bidding_summary_based_on_priority.html.erb </code>

Functionality:

* View topics with their IDs,
* View topic names
* View number of teams that have bid on that specific topic as their 1st 2nd and 3rd priority bid,
* View the names of those teams
* View the total number of bids and finally the percentage of teams that put the specific topic as their first bid.
* View the percentage of first bids with tooltip and custom background
[[File:App-models-bid.rb.jpg|frameless|upright=3]]

== Accomplishment ==
Our recent project milestones have successfully optimized the topic bidding system in Expertiza. These enhancements focus on improving the instructor's user experience and providing comprehensive insights into student preferences during the topic selection process. The new features not only simplify the instructors' interaction with the system but also bring to light the trending topics that resonate most with students.

[[File:Topics_bid_button.jpg|frameless|upright=3]]

In this updated interface, instructors now have the ability to enable topic bidding with a simple checkbox selection, adding efficiency to the setup process. The interface also introduces a new button, "Show bids by priority," which serves as a gateway to a more detailed bid analysis. This new feature simplifies the instructor's oversight of the bidding process, consolidating all the necessary information in one place and enabling quick adjustments to topics based on student interest.

[[File:Tooltip.png|frameless|upright=3]]

Here, instructors can view the entire landscape of student bids in an organized and informative manner. The page lists topics alongside detailed bid data, such as the number of first, second, and third priority bids, total bids, and the teams that have placed those bids. It also features a calculated percentage of first-choice bids for each topic, providing immediate insight into student preferences. A tooltip offers a quick reference for understanding the calculation behind these percentages, ensuring transparency. This visualization tool allows instructors to discern which topics are trending and which may require additional promotion or reevaluation, streamlining the decision-making process without the need to switch between different views.

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

#Test for the method calculate_bidding_summary_based_on_priority in lottery_controller.
The test verifies that the calculate_bidding_summary_based_on_priority method accurately computes and returns a structured summary of bids for topics within an assignment, detailing the number of first, second, and third priority bids, total bids, the percentage of first priority bids, and the teams bidding on each topic.
<pre>describe '#calculate_bidding_summary_based_on_priority' do
it 'calculates and returns bidding summary data for topics' do
# Setup test data
assignment = create(:assignment)
topic = create(:topic, assignment: assignment)
team = create(:team, assignment: assignment)
bid = create(:bid, topic: topic, team: team, priority: 1)
team_name = create(:team_name, team: team)

allow(Assignment).to receive(:find).with(assignment.id).and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([topic])
allow(topic).to receive_message_chain(:bids, :includes).and_return([bid])
allow(bid).to receive_message_chain(:team, :name).and_return(team_name)

# Mock params
params = { id: assignment.id }
allow(controller).to receive(:params).and_return(params)

# Expected data structure from calculate_bidding_summary_based_on_priority
expected_topic_data = [
{
id: topic.id,
name: topic.topic_name,
first_bids: 1,
second_bids: 0,
third_bids: 0,
total_bids: 1,
percentage_first: 100.0,
bidding_teams: [team_name]
}
]

# Call the method
controller.instance_variable_set(:@assignment, assignment)
expect(controller.calculate_bidding_summary_based_on_priority).to eq(expected_topic_data)
end
end
</pre>

#Test for background color helper method
The test suite for LotteryHelper#background_color_by_percentage method checks that it returns appropriate CSS background colors for low, medium, and high percentage values, and defaults to no background when the percentage is out of the 0-100% range.
<pre>

# Assuming your helper module is in the helpers folder
RSpec.describe LotteryHelper, type: :helper do
# Test for low percentage range
describe '#background_color_by_percentage' do
it 'returns light red for low percentages' do
expect(helper.background_color_by_percentage(10)).to eq('background-color: #ffcccc;')
end

# Test for medium percentage range
it 'returns light orange for medium percentages' do
expect(helper.background_color_by_percentage(50)).to eq('background-color: #ffcc99;')
end

# Test for high percentage range
it 'returns light green for high percentages' do
expect(helper.background_color_by_percentage(80)).to eq('background-color: #ccffcc;')
end

# Test for percentage out of range
it 'returns no background for percentages out of range' do
expect(helper.background_color_by_percentage(101)).to eq('background-color: none;')
expect(helper.background_color_by_percentage(-1)).to eq('background-color: none;')
end
end
end
</pre>

== Demo Video ==
You can watch this [https://youtu.be/g9DzKE5otSU Demonstration Video]for a detailed demonstration of the project.

== 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)

===References===
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T01:07:40Z

Skandha: /* Accomplishment */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Problem Statement: ==
===Current Problem===
*Instructors using Expertiza lack comprehensive visibility into the bidding process, impeding their ability to discern the most sought-after topics by teams and the prioritization of choices, leading to inefficient allocation of projects.

===Key Deficiencies===
*The absence of essential details, such as which teams have bid on specific topics and the percentage of teams assigning their top-choice projects, results in instructors resorting to cumbersome workarounds, hindering effective management and allocation of projects.

===Proposed Solution===
*Enhancing Expertiza's interface with a dedicated view for instructors to access detailed statistics on topic bids, including priority rankings, team names, total bids, and the percentage of teams selecting each topic as their top choice. This solution aims to streamline workflow, empower instructors with valuable insights, and facilitate fair and efficient project allocation.

== Previous Implementations ==
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/saisanthoshG/expertiza Github Repository]
#[https://github.com/expertiza/expertiza/pull/2795 E2410 Pull Request]
#[https://youtu.be/g9DzKE5otSU Demo Video]

=== Issues With Previous Implementation ===
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Project Goal ==

The goal of this project is to enhance the Expertiza bidding system, making it more intuitive and efficient for both instructors and students. Our primary focus areas include:

*'''Clarity and Visibility:''' We aim to clearly present bidding results, featuring distinct columns for bid priorities and detailed team bid information.

*'''Separation of Concerns:''' Based on prior feedback, the bidding logic will be separated from the assignment controller to improve system maintainability and adhere to the Single Responsibility Principle.

*'''Enhanced Logic and Navigation:''' The project will introduce refined logic for calculating preferred choice percentages to ensure fairness in topic assignments. Additionally, bidding results will be moved to a dedicated page, improving the user experience by providing a focused and intuitive navigation by adding tooltip to show percentage calculation.

The UI/UX will be redesigned to minimize clutter, ensuring that information is visible only when necessary and enhancing the overall usability of the interface.

By achieving these objectives, we intend to significantly improve the bidding system in Expertiza, ensuring it is a more effective tool for educational environments.

== Design ==

The enhanced workflow in Expertiza enables instructors to manage and review student topic bids efficiently. With the new implementation, instructors visit the Assignments page, select an assignment, and activate the Topics tab to manage topics and enable bidding. A newly added "Show bids by priority" button takes users to a comprehensive bidding summary view. This view categorizes and displays detailed bid information, such as the number and percentage of first-choice bids, offering a clear visualization of students' preferences and facilitating fairer topic assignments.

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagramb.jpeg|frameless|upright=3]]

* Instructors can activate topic bidding with a single checkbox.
* The "Show bids by priority" button leads to a detailed summary view.
* Bids are categorized by priority, displaying #1, #2, and #3 bids.
* The percentage of first-choice bids is clearly presented.
* Bidding teams are listed for complete transparency.

=== Current Flow ===

* Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

* Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

* Now go to Topics section and click "Show bids by priority" button.
[[File:Topics_bid_button.jpg|frameless|upright=3]]

* Here you will be able to view various stats of the bidding,like the topics with their IDs, their respective topic names, number of teams that have put that specific topic as their 1st 2nd and 3rd priority bid, along with the names of those teams, the total number of bids and finally the percentage of teams that put the specific topic as their first bid. We can also see the tooltip for the calculation of the percentages when we hover over the percentages.
[[File:Tooltip.png|frameless|upright=3]]

=== Flow of the Bidding Process ===
* The instructor logs in to Expertiza with instructor credentials.
* They navigate to the Assignments page.
* An assignment is selected from the list and opened for editing.
* The instructor checks the "Has Topics" checkbox to activate the Topics tab.
* The Topics tab is then accessed to add a new topic.
* A new topic is created by filling out the new topic form and submitting it.
* This action updates the topic list, and students can begin bidding, assigning their 1st, 2nd, and 3rd priorities to topics.
* To view the bidding details, the instructor clicks the "Show bids by priority" button on the topics page.

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
====1. Display bidding summary based on priority details ====
==== [https://github.com/expertiza/expertiza/commit/92a7f87eaa07853678c0c922ce147a5e71c20661 Method for bidding analysis] ====
File : <code> app/controllers/lottery_controller.rb </code>

Functionality:

* Added `calculate_bidding_summary_based_on_priority` method to `lottery_controller` for aggregating bid data per topic.
* Prepares data for displaying the bidding details for each topic within an assignment.
* It calculates the number of bids for each priority (1, 2, 3) per topic and also computes
* The overall percentages of teams that received their first, second, and third choice.
* This method is responsible for calculating the bidding table data for an assignment.
* Computes the count of assigned teams for each priority level (1, 2, 3) across all topics.
* It checks each team associated with a topic and determines if the team's bid matches

[[File:1_lottery_code.jpg|frameless|upright=3]]

===2. Background Color according to percentage===
====[https://github.com/expertiza/expertiza/commit/f111f8cc4edd9ebb904237fad185ab86eb4a4a86 Method for background color] ====

File : <code> app/helpers/lottery_helper.rb </code>

Functionality:
* Light red for low percentages
* Light orange for medium percentages
* Light green for high percentages
* No background if outside range
[[File:2_color.jpg|frameless|upright=3]]

===3. Button to show bids by priority===
==== [https://github.com/expertiza/expertiza/commit/11f7b788f6f8bca8dbbfb9477873db07823fc8e9 Button view] ====
File : <code> app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Button to visit the seperate page to view the results of bidding
[[File:3_button.jpg|frameless|upright=3]]

===4. Bidding Summary Table ===
==== [https://github.com/expertiza/expertiza/commit/b798b78c8c6b649caa139044635b05ecd446a62e Summary Table] ====
File : <code> app/views/lottery/calculate_bidding_summary_based_on_priority.html.erb </code>

Functionality:

* View topics with their IDs,
* View topic names
* View number of teams that have bid on that specific topic as their 1st 2nd and 3rd priority bid,
* View the names of those teams
* View the total number of bids and finally the percentage of teams that put the specific topic as their first bid.
* View the percentage of first bids with tooltip and custom background
[[File:App-models-bid.rb.jpg|frameless|upright=3]]

== Accomplishment ==
Our recent project milestones have successfully optimized the topic bidding system in Expertiza. These enhancements focus on improving the instructor's user experience and providing comprehensive insights into student preferences during the topic selection process. The new features not only simplify the instructors' interaction with the system but also bring to light the trending topics that resonate most with students.
[[File:Topics_bid_button.jpg|frameless|upright=3]]

In this updated interface, instructors now have the ability to enable topic bidding with a simple checkbox selection, adding efficiency to the setup process. The interface also introduces a new button, "Show bids by priority," which serves as a gateway to a more detailed bid analysis. This new feature simplifies the instructor's oversight of the bidding process, consolidating all the necessary information in one place and enabling quick adjustments to topics based on student interest.

[[File:Tooltip.png|frameless|upright=3]]

Here, instructors can view the entire landscape of student bids in an organized and informative manner. The page lists topics alongside detailed bid data, such as the number of first, second, and third priority bids, total bids, and the teams that have placed those bids. It also features a calculated percentage of first-choice bids for each topic, providing immediate insight into student preferences. A tooltip offers a quick reference for understanding the calculation behind these percentages, ensuring transparency. This visualization tool allows instructors to discern which topics are trending and which may require additional promotion or reevaluation, streamlining the decision-making process without the need to switch between different views.

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

#Test for the method calculate_bidding_summary_based_on_priority in lottery_controller.
The test verifies that the calculate_bidding_summary_based_on_priority method accurately computes and returns a structured summary of bids for topics within an assignment, detailing the number of first, second, and third priority bids, total bids, the percentage of first priority bids, and the teams bidding on each topic.
<pre>describe '#calculate_bidding_summary_based_on_priority' do
it 'calculates and returns bidding summary data for topics' do
# Setup test data
assignment = create(:assignment)
topic = create(:topic, assignment: assignment)
team = create(:team, assignment: assignment)
bid = create(:bid, topic: topic, team: team, priority: 1)
team_name = create(:team_name, team: team)

allow(Assignment).to receive(:find).with(assignment.id).and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([topic])
allow(topic).to receive_message_chain(:bids, :includes).and_return([bid])
allow(bid).to receive_message_chain(:team, :name).and_return(team_name)

# Mock params
params = { id: assignment.id }
allow(controller).to receive(:params).and_return(params)

# Expected data structure from calculate_bidding_summary_based_on_priority
expected_topic_data = [
{
id: topic.id,
name: topic.topic_name,
first_bids: 1,
second_bids: 0,
third_bids: 0,
total_bids: 1,
percentage_first: 100.0,
bidding_teams: [team_name]
}
]

# Call the method
controller.instance_variable_set(:@assignment, assignment)
expect(controller.calculate_bidding_summary_based_on_priority).to eq(expected_topic_data)
end
end
</pre>

#Test for background color helper method
The test suite for LotteryHelper#background_color_by_percentage method checks that it returns appropriate CSS background colors for low, medium, and high percentage values, and defaults to no background when the percentage is out of the 0-100% range.
<pre>

# Assuming your helper module is in the helpers folder
RSpec.describe LotteryHelper, type: :helper do
# Test for low percentage range
describe '#background_color_by_percentage' do
it 'returns light red for low percentages' do
expect(helper.background_color_by_percentage(10)).to eq('background-color: #ffcccc;')
end

# Test for medium percentage range
it 'returns light orange for medium percentages' do
expect(helper.background_color_by_percentage(50)).to eq('background-color: #ffcc99;')
end

# Test for high percentage range
it 'returns light green for high percentages' do
expect(helper.background_color_by_percentage(80)).to eq('background-color: #ccffcc;')
end

# Test for percentage out of range
it 'returns no background for percentages out of range' do
expect(helper.background_color_by_percentage(101)).to eq('background-color: none;')
expect(helper.background_color_by_percentage(-1)).to eq('background-color: none;')
end
end
end
</pre>

== Demo Video ==
You can watch this [https://youtu.be/g9DzKE5otSU Demonstration Video]for a detailed demonstration of the project.

== 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)

===References===
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T01:00:43Z

Skandha: /* Accomplishment */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T00:41:33Z

Skandha: /* Flow of the Bidding Process */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T00:38:48Z

Skandha: /* Current Flow */

File:Tooltip.png

2024-04-24T00:36:59Z

Skandha:

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T00:32:40Z

Skandha: /* Design */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T00:20:05Z

Skandha: /* Project Goal */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T00:19:31Z

Skandha: /* Proposed Solution */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-24T00:00:45Z

Skandha: /* Issues With Previous Implementation */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-23T23:57:00Z

Skandha: /* Previous Implementations */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-23T23:13:28Z

Skandha: /* Test Login Credentials */

CSC/ECE 517 Spring 2024 - E2410 Reimplement View for results of bidding

2024-04-23T23:12:51Z

Skandha: /* E2410 Current Implementation */

CSC/ECE 517 Spring 2024

2024-03-25T02:00:25Z

Skandha:

* [[CSC/ECE 517 Spring 2024 - E2405 Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2024 - E2407 Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Spring 2024 - E2428 Replicate Roles and Institution UIs ReactJS]]
* [[CSC/ECE 517 Spring 2024 - E2429 Reimplement student_task list]]
* [[CSC/ECE 517 Spring 2024 - E2430 Reimplement student_task view]]
* [[CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding ]]
* [[CSC/ECE 517 Spring 2024 - E2414 Grading Audit Trail]]
* [[CSC/ECE 517 Spring 2024 - NTNX-1 : Extend NDB Operator to Support Postgres HA]]
* [[CSC/ECE 517 Spring 2024 - ‬NTNX-2‬‭ : Snapshot Functionality for provisioned databases]]
* [[CSC/ECE 517 Spring 2024 - E2411 : Fix "Back" link on “New Late Policy” page]]
* [[CSC/ECE 517 Spring 2024 - E2416. Reimplement the Question hierarchy]]
* [[CSC/ECE 517 Spring 2024 - E2420. Reimplement student_quizzes_controller]]
* [[CSC/ECE 517 Spring 2024 - E2424. Reimplement the Bookmarks Controller]]
* [[CSC/ECE 517 Spring 2024 - E2426. Create a UI for Assignment Edit page "Etc" tab in ReactJS]]
* [[CSC/ECE 517 Spring 2024 - E2417. Reimplement submitted content controller.rb]]
* [[CSC/ECE 517 Spring 2024 - E2425. Create a Courses user interface in ReactJS]]
* [[CSC/ECE 517 Spring 2024 - E2431. Reimplement grades/view_team]]
* [[CSC/ECE 517 Spring 2024 - E2404 Refactor student teams functionality]]
* [[CSC/ECE 517 Spring 2024 - E2403 Mentor-Meeting Management]]
* [[CSC/ECE 517 Spring 2024 - E2421. Reimplement impersonating users (within impersonate controller.rb)]]
* [[CSC/ECE 517 Spring 2024 - E2413. Testing - Answer Tagging]]
* [[CSC/ECE 517 Spring 2024 - E2412. Testing for hamer.rb]]
* [[CSC/ECE 517 Spring 2024 - E2427. UI for questionnaire.rb]]
* [[CSC/ECE 517 Spring 2024 - E2419. Reimplement duties controller.rb and badges controller.rb]]
* [[CSC/ECE 517 Spring 2024 - E2432. UI for Participants.rb]]
* [[CSC/ECE 517 Spring 2024 - G2402 Implement REST client, REST API, and Graphql API endpoint for repositories]]

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:56:57Z

Skandha: /* RSpec Testing */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagramb.jpeg|frameless|upright=3]]

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

=== Flowchart for Bidding Process ===

[[File:flow chartb.jpeg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment_controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:53:48Z

Skandha: /* Sequence Diagram for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagramb.jpeg|frameless|upright=3]]

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

=== Flowchart for Bidding Process ===

[[File:flow chartb.jpeg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

File:Sequence Diagramb.jpeg

2024-03-25T01:53:32Z

Skandha:

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:53:01Z

Skandha: /* Sequence Diagram for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagram.jpeg|frameless|upright=3]]

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

=== Flowchart for Bidding Process ===

[[File:flow chartb.jpeg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

File:Sequence Diagram.jpeg

2024-03-25T01:52:14Z

Skandha: Skandha uploaded a new version of File:Sequence Diagram.jpeg

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:50:43Z

Skandha: /* Flowchart for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

<div style="padding-top: 20px;">
[[File:Sequence Diagram.jpeg|frameless|upright=3]]
</div>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

=== Flowchart for Bidding Process ===

[[File:flow chartb.jpeg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

File:Sequence Diagram.jpeg

2024-03-25T01:50:01Z

Skandha: Skandha uploaded a new version of File:Sequence Diagram.jpeg

File:Flow chartb.jpeg

2024-03-25T01:49:51Z

Skandha:

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:48:30Z

Skandha: /* Flowchart for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

<div style="padding-top: 20px;">
[[File:Sequence Diagram.jpeg|frameless|upright=3]]
</div>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

=== Flowchart for Bidding Process ===

[[File:flowchartb.jpeg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:47:20Z

Skandha:

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

<div style="padding-top: 20px;">
[[File:Sequence Diagram.jpeg|frameless|upright=3]]
</div>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

=== Flowchart for Bidding Process ===

[[File:flowchart.jpeg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

File:Flowchart.jpeg

2024-03-25T01:46:47Z

Skandha: Skandha uploaded a new version of File:Flowchart.jpeg

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:46:04Z

Skandha: /* Design */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

<div style="padding-top: 20px;">
[[File:Sequence Diagram.jpeg|frameless|upright=3]]
</div>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

=== Flowchart for Bidding Process ===

[[File:flowchart.png|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:43:55Z

Skandha: /* Sequence Diagram for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

<div style="padding-top: 20px;">
[[File:Sequence Diagram.jpeg|frameless|upright=3]]
</div>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:41:21Z

Skandha: /* Sequence Diagram for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

[[File:Sequence Diagram.jpeg|frameless|upright=3]]

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:40:24Z

Skandha: /* Sequence Diagram for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

[File:Sequence Diagram.jpeg|frameless|upright=3]

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:39:58Z

Skandha: /* Sequence Diagram for Bidding Process */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===

[File:Sequence Diagram.jpeg|frameless|upright=3]]

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:38:59Z

Skandha: /* Accomplishment */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===
<center>[[File:Sequence Diagram.jpeg|frameless|upright=3]]</center>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.

[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:35:18Z

Skandha: /* Manual Testing */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===
<center>[[File:Sequence Diagram.jpeg|frameless|upright=3]]</center>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

* Navigate to the assignments page and click on the pencil icon next to the 'Test OODD' assignment.
* Confirm that the 'Has Topics' checkbox is selected on the general assignment settings page.
* Move to the 'Topics' tab and check the 'Enable bidding for topics' option.
* Add a new topic for students to bid on by clicking the 'New Topic' button and entering relevant details.
* Log in as a student and bid on the new topic, choosing the priority level for the bid.
* Return to the 'Topics' tab as an instructor to view the updated bidding table with bids and priorities listed.
* Confirm that the total number of bids and the number of #1, #2, and #3 bids are displayed correctly for each topic.
* Check the background color coding (green, yellow, red) in the bidding table that reflects the intensity of bids for visual verification.

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:33:08Z

Skandha: /* Manual Testing */

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===
<center>[[File:Sequence Diagram.jpeg|frameless|upright=3]]</center>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

Follow these instructions to manually test the below functionality:

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:32:19Z

Skandha:

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===
<center>[[File:Sequence Diagram.jpeg|frameless|upright=3]]</center>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

===RSpec Testing===

The assignment_controller_spec.rb has existing automated rspec tests in place. Furthermore following tests were added to the code to ensure the functionality is working as expected and thereby increasing code coverage:-

-> assignment__controller_spec.rb

<pre>describe '#bidding_details' do
it 'assigns necessary variables and renders bidding_details template' do
allow(Assignment).to receive(:find).with('1').and_return(assignment)
allow(assignment).to receive(:sign_up_topics).and_return([double('SignUpTopic', id: 1)])
allow(Bid).to receive(:where).with(topic_id: 1).and_return([])
allow(assignment).to receive(:calculate_percentage_of_teams_getting_choices).and_return({})
allow(assignment).to receive(:teams_bidding_for_each_topic).and_return({})
allow(assignment).to receive(:assigned_teams_for_topics).and_return({})

get :bidding_details, params: { id: 1 }

expect(assigns(:assignment)).to eq(assignment)
expect(assigns(:bids_by_topic)).to eq({ 1 => [] })
expect(response).to render_template('bidding_details')
end
end

describe '#bidding_details_for_topic' do
it 'assigns necessary variables and renders bidding_details_for_topic template' do
topic = double('SignUpTopic', id: 1)
bids = [double('Bid')]

allow(SignUpTopic).to receive(:includes).with(:bids).and_return(SignUpTopic)
allow(SignUpTopic).to receive(:find).with(1).and_return(topic)
allow(topic).to receive(:bids).and_return(bids)

get :bidding_details_for_topic, params: { topic_id: 1 }, format: :js

expect(assigns(:topic)).to eq(topic)
expect(assigns(:bids)).to eq(bids)
expect(response).to render_template('bidding_details_for_topic')
end
end

</pre>

Similarly, the file assignment_spec.rb have the automated rspec tests in them, Few more test case were added to verify the functionalities added.

-> assignment_spec.rb

<pre>describe '#calculate_percentage_of_teams_getting_choices' do
it 'calculates the percentage of teams getting their choices' do
# Mock necessary objects for the test
assignment = build(:assignment)
team1 = build(:team)
team2 = build(:team)
topic1 = build(:sign_up_topic, assignment_id: assignment.id)
topic2 = build(:sign_up_topic, assignment_id: assignment.id)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive(:sign_up_topics).and_return([topic1, topic2])
allow(Team).to receive(:where).and_return([team1, team2])
allow(team1).to receive(:bid_for_topic).with(topic1).and_return(bid1)
allow(team1).to receive(:bid_for_topic).with(topic2).and_return(bid2)
allow(team2).to receive(:bid_for_topic).with(topic2).and_return(bid3)

# Perform the calculation
percentages = assignment.calculate_percentage_of_teams_getting_choices

# Perform your assertions here
expect(percentages[1]).to eq(50.0)
expect(percentages[2]).to eq(100.0)
end
end

describe '#teams_bidding_for_each_topic' do
it 'returns teams bidding for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team)
team2 = build(:team)
bid1 = build(:bid, team: team1, topic: topic1)
bid2 = build(:bid, team: team1, topic: topic2)
bid3 = build(:bid, team: team2, topic: topic2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :map).and_return([['Team1', 1]])
allow(topic2).to receive_message_chain(:bids, :map).and_return([['Team1', 1], ['Team2', 2]])

# Call the method
result = assignment.teams_bidding_for_each_topic

# Perform assertions
expect(result[1]).to eq([['Team1', 1]])
expect(result[2]).to eq([['Team1', 1], ['Team2', 2]])
end
end

describe '#bidding_info_by_topic' do
it 'returns bidding information by topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
bid1 = build(:bid, team: team1, priority: 1)
bid2 = build(:bid, team: team2, priority: 2)
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team1', bid_priority: 1 }])
allow(topic2).to receive_message_chain(:bids, :includes, :map).and_return([{ team_name: 'Team2', bid_priority: 2 }])

# Call the method
result = assignment.bidding_info_by_topic

# Perform assertions
expect(result[1]).to eq([{ team_name: 'Team1', bid_priority: 1 }])
expect(result[2]).to eq([{ team_name: 'Team2', bid_priority: 2 }])
end
end

describe '#assigned_teams_for_topics' do
it 'returns assigned teams for each topic' do
# Mock necessary objects for the test
assignment = build(:assignment)
topic1 = build(:sign_up_topic, id: 1)
topic2 = build(:sign_up_topic, id: 2)
team1 = build(:team, name: 'Team1')
team2 = build(:team, name: 'Team2')
allow(assignment).to receive_message_chain(:sign_up_topics, :includes).and_return([topic1, topic2])
allow(topic1).to receive_message_chain(:assigned_teams, :map).and_return(['Team1'])
allow(topic2).to receive_message_chain(:assigned_teams, :map).and_return(['Team2'])

# Call the method
result = assignment.assigned_teams_for_topics

# Perform assertions
expect(result[1]).to eq(['Team1'])
expect(result[2]).to eq(['Team2'])
end
end

</pre>

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

File:M2spec.png

2024-03-25T01:27:01Z

Skandha:

File:M1spec.png

2024-03-25T01:26:55Z

Skandha:

File:Cspec.png

2024-03-25T01:26:48Z

Skandha:

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:23:48Z

Skandha:

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===
<center>[[File:Sequence Diagram.jpeg|frameless|upright=3]]</center>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Test Plan ==

=== Manual Testing ===

=== Rspec Testing ===

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:21:04Z

Skandha:

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===
<center>[[File:Sequence Diagram.jpeg|frameless|upright=3]]</center>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:19:44Z

Skandha:

== 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 facets such as user profiles, courses, assignments, questionnaires, and reviews. With its user-friendly interface and innovative features, Expertiza revolutionizes collaborative learning, facilitating seamless topic creation, group formation, and peer review. Join us in embracing the transformative potential of digital collaboration to redefine the educational experience.

== Test Login Credentials ==
<li>UserId: instructor6</li>
<li>Password: password</li>

== Problem Statement: ==
#Instructors currently lack comprehensive visibility into the bidding process, hindering their ability to understand which topics are most sought after by teams and how teams prioritize their choices.
#The current system does not provide instructors with essential details such as which teams have bid on specific topics and the percentage of teams assigned their top-choice project.
#As a result, instructors resort to inefficient workarounds, such as logging in as students to view topic details, which complicates the process and delays access to critical bidding information.
#This lack of functionality fails to meet instructors' needs for a comprehensive overview of the bidding process, preventing them from effectively managing and allocating projects to teams.
#Enhancing the topics page and providing instructors with a summary view of the bidding process would empower them with valuable insights, streamline their workflow, and ensure they have the necessary tools to facilitate a fair and efficient project allocation process.

=== Previous Implementations ===
#[https://github.com/Shreshth-Malik/expertiza E2360 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2659 E2360 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding E2360 Wiki Page]
#[https://www.youtube.com/watch?v=pGmHyqLj7PM Demo Video]

#[https://github.com/dnguyenv/expertiza/tree/beta E2245 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2392 E2245 Pull Request]
#[https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding E2245 Wiki Page]
#[https://www.youtube.com/watch?v=OTSRqRihahQ Demo Video]

=== E2410 Current Implementation ===
#[https://github.com/shiva1239/expertiza E2410 Github Repository]
#[https://github.com/expertiza/expertiza/pull/2768 E2410 Pull Request]
#[https://www.youtube.com/watch?v=rfnwqOjLOJ0 Demo Video]

=== Issues With Previous Implementation ===
# Functions directly fetch and process bids in the controller, which could be better managed through model methods for improved organization.
# The use of instance variables for bid counts is not scalable and can become problematic with changes in the bidding process.
# The current approach of fetching topics and iterating for bids may result in inefficient N+1 queries.
# There's a risk of repeating logic related to bidding across different parts of the application.
# UI elements and logic are intertwined within the controller, which is not ideal for MVC patterns.
# The views have repetitive non-zero checks for bid counts, which could be streamlined.
# CSS styles are hard-coded in views, which should be abstracted to CSS files.
# Missing error handling could cause unhandled exceptions for nonexistent bids or topics.
# Tests might not cover all scenarios, such as incorrect bid priorities or unrepresented teams.
# The UI lacks dynamic feedback mechanisms like AJAX updates for user interactions.

== Proposed Solution ==
The design presented in this iteration of the project is very similar to the high-level design proposed last year in [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding Fall 2023 Design]. Since this pull request was not merged, we have included the proposed changes that are credible. Below is a comparable explanation of the previously offered remedy, as well as some new design decisions to improve upon the previous iteration of this issue.

We've significantly improved the bidding system in Expertiza by enhancing the visibility and handling of bids for topics. Key improvements include detailed bidding data presentation, with distinct columns for each bid priority and clear team bid information. This offers users, both instructors and students, a transparent view into the bidding outcomes. Additionally, our refined logic more accurately calculates teams' preferred choice percentages, aiding better decision-making in topic assignments.

== Design ==

=== Sequence Diagram for Bidding Process ===
<center>[[File:Sequence Diagram.jpeg|frameless|upright=3]]</center>

=== Current Flow ===

*Go to the assignments section, we have created a dummy a assignment, "Test OODD", click edit icon next to it.
[[File:2410 1.jpeg|frameless|upright=3]]

*Now make sure the "has topics" checkbox is selected.
[[File:24104.jpeg|frameless|upright=3]]

*Now go to Topics section and scroll down to Bid Summary.
[[File:2410 2.jpeg|frameless|upright=3]]

*Here you will be able to view various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Implementation Details ==
=== Files Modified During the implementation ===

* assignments_controller.rb
* lottery_controller.rb
* assignment.rb
* bid.rb
* team.rb
* assignment_helper.rb
* _topics.html.erb
* bidding_details.html.erb
* _bid_summary_partial.html.erb

=== New functions that are implemented ===
'''1. Assignment Controller '''

File : <code> ./app/controllers/assignments_controller.rb </code>

Functionality:

* Added `bidding_details` method to `AssignmentController` for aggregating bid data per topic.
* Implemented data retrieval for each topic's bids within an assignment using `@assignment.sign_up_topics`.
* Compiled a list of teams assigned to topics, excluding those on the waitlist.
* Introduced dynamic counting of bids per priority (1, 2, 3) for each topic and stored the results in `@count1`, `@count2`, and `@count3`.
* Calculated the total number of teams and their respective percentages for obtaining their first, second, and third choice topics.
* Created `bidding_details_for_topic` method to handle AJAX requests and render bid details for a specific topic.
* Structured bid data retrieval to support interactive, on-the-fly updates in the user interface.

[[File:App-controller-assignments_controller.jpg|frameless|upright=3]]

'''2. Lottery Controller'''

File : <code> ./app/controllers/lottery_controller.rb </code>

Functionality:

(1) Fetching Assignment and Topics:
* The method retrieves an `Assignment` object based on the provided `id` parameter.
* It then fetches all `SignUpTopic` objects associated with this assignment, storing them in the `@topics` instance variable.

(2) Gathering Bids Data:
* It initializes an empty hash `@bids_by_topic` to store bid information by topic.
* Iterates over each topic and queries the `Bid` model to fetch all bids associated with that topic. Each bid's team and priority information are encapsulated in a hash and stored in the `@bids_by_topic`, keyed by topic ID.

(3) Team Assignments Tracking:
* Similarly, `@assigned_teams_by_topic` is prepared to hold information on teams assigned to each topic. This is populated by querying `SignedUpTeam` for non-waitlisted teams for each topic.

(4) Dynamic Instance Variables for Priority Counts:
* The code dynamically initializes and updates three instance variables: `@count1`, `@count2`, and `@count3` for each priority level (1, 2, 3). These variables are hashes that count the number of bids at each priority level for each topic.

(5) Percentage Calculations:
* After collecting bids and assigned teams, it calculates the total number of teams that made bids and computes the percentage of teams that received their first, second, and third choices. This is facilitated by helper methods `compute_priority_counts` and `compute_percentages`.

(6) Overall Method Functionality:
* The method effectively prepares a comprehensive data structure detailing the bids for each topic within the assignment. This includes the number of bids at each priority level and the percentages of teams that were able to secure their preferences. This data is essential for presenting a clear picture of the bidding results to the instructors or other stakeholders.

(7) End Result:
* The computed data is then used to render a view or to further business logic, providing insight into the distribution and success of bids across the different topics, thus aiding in intelligent assignment and team formation based on bidding data.
[[File:App-controllers-lottery controller.rb.jpg|frameless|upright=3]]

'''3. Assignment Model '''

File : <code> ./app/models/assignment.rb </code>

Functionality:

* ⁠Calculates the percentage of teams that have been awarded their first, second, and third choice topics based on bidding.
* ⁠Utilizes a hash to keep count of the choices, initializing at zero for each choice level.
* ⁠Iterates over each team to determine if they've been assigned a topic and subsequently increments the count of the choice they've made.
* ⁠Counts the total number of teams to avoid division by zero errors when calculating percentages.
* ⁠Transforms the counts into percentages by dividing by the total number of teams and multiplying by 100, rounding to two decimal places.
* ⁠Provides the calculated percentages for use in views or other parts of the application.

[[File:assignment model.png|frameless|upright=3]]

'''4. Bid Model '''

File : <code> ./app/models/bid.rb </code>

Functionality:

* The method for merging bid data from different users was refined with clearer comments.
* The method now organizes bidding information into a matrix structure, keyed by topic, simplifying the representation of bids for analysis.
* A new method was introduced to calculate the percentages of teams receiving their preferred choices, with logic to prevent division by zero.
* The data is then normalized to percentages, providing a concise and accurate calculation for bid analytics.

[[File:App-models-bid.rb.jpg|frameless|upright=3]]

'''5. Team Model '''

File : <code> ./app/models/team.rb </code>

Functionality:

* Expanded the Team model with methods to fetch a team’s bid for a given topic.
* Added functionality to retrieve the assigned sign-up topic for a team.
* Refined the Team model's interface for interacting with associated bids and sign-up topics.

[[File:bid model.png|frameless|upright=3]]

'''6. Assignment Helper '''

File : <code> ./app/helpers/assignment_helper.rb </code>

Functionality:

The ⁠ bid_intensity_class ⁠ method in the Assignment Helper serves the following functions:

* Determines the CSS class to be applied based on the total number of bids for a topic.
* If the total bids are between 0 and 5, it returns the class name 'bid-low-intensity'.
* For total bids between 6 and 10, it returns 'bid-medium-intensity'.
* If the number of bids exceeds 10, it yields 'bid-high-intensity'.
* This method assists in visually differentiating the intensity of bidding on topics through color-coding or other styling cues in the user interface.

[[File:assignmenthelper.png|frameless|upright=3]]

'''7. Topics view'''

File : <code> ./app/views/assignments/edit/_topics.html.erb </code>

Functionality:

* ⁠Introduced conditional checks for displaying specific sections in the topics form based on the assignment's properties like whether it allows suggestions, is intelligent, has a staggered deadline, etc.
* ⁠Added a summary section to display aggregated bidding data if bidding is enabled.
* ⁠Created a dynamic table that lists out the topic names, the count of first, second, and third priority bids, total bids, and names of bidding teams.
*⁠ ⁠Implemented a method to classify bid intensity into low, medium, and high based on the total number of bids.
* ⁠Added modals to provide detailed bidding information for each topic, which will be populated via an AJAX call to a specified endpoint with the topic ID.
* ⁠Set up a JavaScript function to handle click events on information buttons, triggering AJAX calls and displaying bid details in modals.

[[File:topics1.png|frameless|upright=3]]

[[File:topics2.png|frameless|upright=3]]

[[File:topics3.png|frameless|upright=3]]

'''8. Bidding Details view'''

File : <code>./app/views/assignments/bidding_details.html.erb </code>

Functionality:

* Displays the header "Bidding Details" along with the name of the current assignment.
* Iterates over each topic that has received bids.
* Retrieves and displays the name of each topic.
* Creates a table structure with headers "Team Name" and "Bid Priority".
* Loops through the bids associated with each topic.
* For each bid, it displays the name of the team that placed the bid.
* Also for each bid, it displays the priority level of the bid (e.g., 1st priority, 2nd priority).
* Structures the data in a tabular format for clear visualization of teams and their bidding priorities per topic.

[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''9. Bid Summary view'''

File : <code> ./app/views/assignments/_bid_summary_partial.html.erb </code>

Functionality:

* ⁠The snippet is part of a view template that generates a summary of bidding data for assignment topics.
* ⁠It checks if there are any sign-up topics associated with the assignment.
* ⁠For each topic, it lists out the total number of bids, along with a breakdown of bids by priority level: first, second, and third.
* ⁠It also displays the names of teams that have placed bids on the topic.
* ⁠The percentage of teams that got their first choice is calculated and displayed, color-coded to indicate the outcome:
** Red for 0%, indicating no team got their first choice.
** Green for 100%, indicating all teams got their first choice.
** Orange for any percentage in between.
* ⁠If no bids are present for a topic, it notes that.
* ⁠If there are no topics created for the assignment, it informs the user accordingly.

[[File:App-views-assignments- bid summary partial.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which enables the instructor to see various stats of the bidding, like the percentage of teams that got their first choice of project, the number of teams that put the particular project as their first, second and third choice and the individual teams which bid on the particular project.
[[File:Screenshot 2024-03-24 at 11.42.05 AM.jpg|frameless|upright=3]]

== Demo Video ==
You can watch this [https://youtu.be/rfnwqOjLOJ0 demo video]for a detailed demonstration of the project.

== 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)

==References==
*https://github.com/expertiza/expertiza
*http://expertiza.ncsu.edu/
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:16:05Z

Skandha:

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:13:33Z

Skandha:

CSC/ECE 517 Spring 2024 - E2410. View for Results of Bidding

2024-03-25T01:12:33Z

Skandha:

File:Assignmenthelper.png

2024-03-25T01:09:50Z

Skandha: