Expertiza_Wiki - User contributions [en]

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

2024-04-24T00:32:06Z

Cpwalinj:

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

2024-04-24T00:24:29Z

Cpwalinj:

File:Bidding sum view1.jpg

2024-04-24T00:22:40Z

Cpwalinj:

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

2024-04-23T17:45:50Z

Cpwalinj:

== 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 Reimplement View for results of bidding

2024-04-23T17:45:12Z

Cpwalinj:

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

2024-04-22T21:35:47Z

Cpwalinj:

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

2024-04-22T21:32:24Z

Cpwalinj:

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

2024-04-22T21:20:53Z

Cpwalinj:

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

2024-04-22T20:19:03Z

Cpwalinj:

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

2024-04-22T19:58:36Z

Cpwalinj:

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

2024-04-22T19:56:57Z

Cpwalinj:

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

2024-04-22T19:51:54Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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. 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 ==
This project has added a "Bid Summary", which allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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. View for Results of Bidding

2024-04-22T19:47:17Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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. 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.
[[File:App-models-bid.rb.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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. View for Results of Bidding

2024-04-22T19:41:36Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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. 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'''

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'''

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 '''

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.
[[File:App-models-bid.rb.jpg|frameless|upright=3]]

== Accomplishment ==
This project has added a "Bid Summary", which allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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. View for Results of Bidding

2024-04-22T18:59:55Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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. 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'''

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'''

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 '''

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.
[[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 allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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. View for Results of Bidding

2024-04-22T18:46:10Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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. 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'''

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'''

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. 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 allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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

File:3 button.jpg

2024-04-22T18:45:51Z

Cpwalinj:

File:2 color.jpg

2024-04-22T18:42:16Z

Cpwalinj:

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

2024-04-22T18:41:48Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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. 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'''

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. 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 allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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. View for Results of Bidding

2024-04-22T18:37:32Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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. 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. 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 allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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

File:1 lottery code.jpg

2024-04-22T18:37:19Z

Cpwalinj:

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

2024-04-22T18:15:09Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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 '''
=== [https://github.com/expertiza/expertiza/commit/92a7f87eaa07853678c0c922ce147a5e71c20661 Method for bidding analysis] ===
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 allows the instructor to see all 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. This information will allow us to see which topic is most trending, ie, what is the topic most students want to work on, and which topics are not doing so well. This enables the instructor to get this information without having to login to the student view and figure this out manually.
[[File:Bidding_sum_view.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://www.youtube.com/watch?v=4x_FmhwCU6s 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. View for Results of Bidding

2024-04-22T17:23:00Z

Cpwalinj:

== 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: ==
'''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]

#[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. This has also been moved to a separate page, to improve user-experience.

== 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 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.
[[File:Bidding_sum_view.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:Topics bid button.jpg

2024-04-22T16:53:54Z

Cpwalinj:

File:Bidding sum view.jpg

2024-04-22T16:50:49Z

Cpwalinj:

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

2024-04-09T02:22:52Z

Cpwalinj:

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

2024-04-09T02:21:32Z

Cpwalinj:

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

2024-04-09T02:18:34Z

Cpwalinj:

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

2024-04-09T02:18:06Z

Cpwalinj:

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

2024-04-09T02:16:57Z

Cpwalinj:

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

2024-04-09T02:16:17Z

Cpwalinj:

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

2024-04-09T02:15:08Z

Cpwalinj:

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

2024-04-09T01:52:05Z

Cpwalinj:

== Expertiza ==
[http://expertiza.ncsu.edu/ Expertiza] is an open-source web application built on Ruby on Rails that enables instructors to create customized assignments with topic lists for students to choose from. It facilitates team formation, allowing students to collaborate on assignments and projects. Expertiza supports peer review processes where students can provide feedback on each other's submissions across various document formats, including URLs and wiki pages. This freely available platform provides a flexible and comprehensive solution for managing assignments, teamwork, and peer evaluations.

== Introduction ==
The project focuses on decluttering the bidding view interface to offer a more intuitive user experience. This will not only improve readability and maintainability but also ensure the code adheres to design principles such as the Single Responsibility Principle. The initiative promises to reduce redundancy and elevate the overall functionality of the platform, paving the way for a more robust and user-centric application.

==Problem Statement==
The reimplementation project entails:
*Enhance the user interface of the bidding view to make it less cluttered and more user-friendly.
*Refactor the assignment_controller.rb by extracting the bidding logic into a separate controller, bidding_logic_controller.rb, to adhere to SRP.
*Improve the readability and maintainability of the codebase by implementing meaningful method names and adhering to design principles.
*Reduce redundancy in the code and promote reusability across different models within the platform.

==Plan for Reimplementation of GradesController==

====Refactoring assignment Controller:====
File: <code>app/controllers/assignment_controller.rb </code>
Refactor the bidding_details method to a more clear method nameEnhancing code clarity. Separate the bidding logic from the assignment controller to adhere to the Single Responsibility Principle (SRP).

====Improving Bidding View:====
Files: <code>app/views/assignments/edit/_topics.html.erb</code> ⁠, ⁠<code>app/views/assignments/n</code> , <code>bidding_details.html.erb</code>
Consolidate the bidding details summary view into a single table for improved clarity and organization. Implement interactive features such as modals or tooltips to provide additional context or information.

====Meaningful Method Names:====
Files: <code>app/controllers/assignment_controller.rb</code> ⁠, <code>app/models/assignment.rb</code> ⁠, ⁠ <code>app/models/team.rb</code> ⁠, ⁠ <code>app/models/bid.rb</code> ⁠
Review existing method names and replace generic or unclear names with descriptive ones that accurately reflect their purpose and functionality ensuring consistency.

====Adherence to Design Principles:====
Files: <code>app/controllers/assignment_controller.rb</code> ⁠, ⁠ <code>app/models/assignment.rb</code> ⁠, ⁠ <code>app/models/team.rb</code> ⁠, ⁠ app/models/bid.rb </code>⁠
Refactor code segments to eliminate redundancy and promote code reusability. Stick to the design principles listed below.

== Design Principles ==

==== Single Responsibility Principle (SRP): ====
*Each action in the GradesController will be responsible for a specific task related to managing grades.
*Actions will be refactored to separate concerns such as data retrieval, computation, and view rendering.
*For example, the `view` action will focus solely on retrieving grading data and rendering the grading report.

==== Don't Repeat Yourself (DRY) Principle: ====
*Code duplication in the GradesController will be eliminated by extracting common functionality into helper methods or modules.
*Repetitive logic, such as retrieving questions or calculating penalties, will be refactored to promote code reusability and maintainability.

==== Dependency Inversion Principle (DIP): ====
*The GradesController will depend on abstractions, interfaces, or higher-level modules instead of concrete implementations.
*Dependency injection or inversion of control will be used to decouple the controller from specific database or service implementations.

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

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

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

2024-04-09T01:46:54Z

Cpwalinj:

== Expertiza ==
[http://expertiza.ncsu.edu/ Expertiza] is an open-source web application built on Ruby on Rails that enables instructors to create customized assignments with topic lists for students to choose from. It facilitates team formation, allowing students to collaborate on assignments and projects. Expertiza supports peer review processes where students can provide feedback on each other's submissions across various document formats, including URLs and wiki pages. This freely available platform provides a flexible and comprehensive solution for managing assignments, teamwork, and peer evaluations.

== Introduction ==
We will be improving the UI for bidding view to appear less cluttered.
We're refactoring the assignment_controller.rb in Expertiza, adding a bidding_logic_controller.rb with a seperate method "topic_wise_bidding_teams" enhancing its codebase to adhere to design principles, improving readability, and reducing redundancy.

==Problem Statement==
The reimplementation project entails:
*Enhance the user interface of the bidding view to make it less cluttered and more user-friendly.
*Refactor the assignment_controller.rb by extracting the bidding logic into a separate controller, bidding_logic_controller.rb, to adhere to SRP.
*Improve the readability and maintainability of the codebase by implementing meaningful method names and adhering to design principles.
*Reduce redundancy in the code and promote reusability across different models within the platform.

==Plan for Reimplementation of GradesController==

====Refactoring assignment Controller:====
File: <code>app/controllers/assignment_controller.rb </code>
Refactor the bidding_details method to a more clear method nameEnhancing code clarity. Separate the bidding logic from the assignment controller to adhere to the Single Responsibility Principle (SRP).

====Improving Bidding View:====
Files: <code>app/views/assignments/edit/_topics.html.erb</code> ⁠, ⁠<code>app/views/assignments/n</code> , <code>bidding_details.html.erb</code>
Consolidate the bidding details summary view into a single table for improved clarity and organization. Implement interactive features such as modals or tooltips to provide additional context or information.

====Meaningful Method Names:====
Files: <code>app/controllers/assignment_controller.rb</code> ⁠, <code>app/models/assignment.rb</code> ⁠, ⁠ <code>app/models/team.rb</code> ⁠, ⁠ <code>app/models/bid.rb</code> ⁠
Review existing method names and replace generic or unclear names with descriptive ones that accurately reflect their purpose and functionality ensuring consistency.

====Adherence to Design Principles:====
Files: <code>app/controllers/assignment_controller.rb</code> ⁠, ⁠ <code>app/models/assignment.rb</code> ⁠, ⁠ <code>app/models/team.rb</code> ⁠, ⁠ app/models/bid.rb </code>⁠
Refactor code segments to eliminate redundancy and promote code reusability. Stick to the design principles listed below.

== Design Principles ==

==== Single Responsibility Principle (SRP): ====
*Each action in the GradesController will be responsible for a specific task related to managing grades.
*Actions will be refactored to separate concerns such as data retrieval, computation, and view rendering.
*For example, the `view` action will focus solely on retrieving grading data and rendering the grading report.

==== Don't Repeat Yourself (DRY) Principle: ====
*Code duplication in the GradesController will be eliminated by extracting common functionality into helper methods or modules.
*Repetitive logic, such as retrieving questions or calculating penalties, will be refactored to promote code reusability and maintainability.

==== Dependency Inversion Principle (DIP): ====
*The GradesController will depend on abstractions, interfaces, or higher-level modules instead of concrete implementations.
*Dependency injection or inversion of control will be used to decouple the controller from specific database or service implementations.

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

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

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

2024-04-09T01:45:49Z

Cpwalinj:

== Expertiza ==
[http://expertiza.ncsu.edu/ Expertiza] is an open-source web application built on Ruby on Rails that enables instructors to create customized assignments with topic lists for students to choose from. It facilitates team formation, allowing students to collaborate on assignments and projects. Expertiza supports peer review processes where students can provide feedback on each other's submissions across various document formats, including URLs and wiki pages. This freely available platform provides a flexible and comprehensive solution for managing assignments, teamwork, and peer evaluations.

== Introduction ==
We will be improving the UI for bidding view to appear less cluttered.
We're refactoring the assignment_controller.rb in Expertiza, adding a bidding_logic_controller.rb with a seperate method "topic_wise_bidding_teams" enhancing its codebase to adhere to design principles, improving readability, and reducing redundancy.

==Problem Statement==
The reimplementation project entails:
*Enhance the user interface of the bidding view to make it less cluttered and more user-friendly.
*Refactor the assignment_controller.rb by extracting the bidding logic into a separate controller, bidding_logic_controller.rb, to adhere to SRP.
*Improve the readability and maintainability of the codebase by implementing meaningful method names and adhering to design principles.
*Reduce redundancy in the code and promote reusability across different models within the platform.

==Plan for Reimplementation of GradesController==

====Refactoring assignment Controller:====
File: <code>app/controllers/assignment_controller.rb </code>
Refactor the bidding_details method to a more clear method nameEnhancing code clarity. Separate the bidding logic from the assignment controller to adhere to the Single Responsibility Principle (SRP).

====Improving Bidding View:====
Files: <code>app/views/assignments/edit/_topics.html.erb</code> ⁠, ⁠<code>app/views/assignments/n</code> , <code>bidding_details.html.erb</code>
Consolidate the bidding details summary view into a single table for improved clarity and organization. Implement interactive features such as modals or tooltips to provide additional context or information.

====Meaningful Method Names:====
Files: <code>app/controllers/assignment_controller.rb</code> ⁠, <code>app/models/assignment.rb</code> ⁠, ⁠ <code>app/models/team.rb</code> ⁠, ⁠ <code>app/models/bid.rb</code> ⁠
Review existing method names and replace generic or unclear names with descriptive ones that accurately reflect their purpose and functionality ensuring consistency.

====Adherence to Design Principles:====
Files: <code>app/controllers/assignment_controller.rb</code> ⁠, ⁠ <code>app/models/assignment.rb</code> ⁠, ⁠ <code>app/models/team.rb</code> ⁠, ⁠ app/models/bid.rb </code>⁠
Refactor code segments to eliminate redundancy and promote code reusability. Stick to the design principles listed below.

== Design Principles ==

==== Single Responsibility Principle (SRP): ====
*Each action in the GradesController will be responsible for a specific task related to managing grades.
*Actions will be refactored to separate concerns such as data retrieval, computation, and view rendering.
*For example, the `view` action will focus solely on retrieving grading data and rendering the grading report.

==== Don't Repeat Yourself (DRY) Principle: ====
*Code duplication in the GradesController will be eliminated by extracting common functionality into helper methods or modules.
*Repetitive logic, such as retrieving questions or calculating penalties, will be refactored to promote code reusability and maintainability.

==== Dependency Inversion Principle (DIP): ====
*The GradesController will depend on abstractions, interfaces, or higher-level modules instead of concrete implementations.
*Dependency injection or inversion of control will be used to decouple the controller from specific database or service implementations.

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

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

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

2024-04-09T01:43:42Z

Cpwalinj:

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

2024-04-09T01:41:48Z

Cpwalinj:

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

2024-04-09T01:41:20Z

Cpwalinj:

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

2024-04-09T01:40:37Z

Cpwalinj:

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

2024-04-09T01:39:45Z

Cpwalinj:

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

2024-04-09T01:37:18Z

Cpwalinj:

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

2024-04-09T01:35:35Z

Cpwalinj:

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

2024-04-09T00:36:08Z

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

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

2024-03-24T19:51:03Z

Cpwalinj:

= Introduction =
Expertiza is an open source project based on Ruby on Rails framework. It is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. Expertiza enables the instructor to create new and customize existing assignments. It also enables the instructor to create a list of topics the students can sign up for as part of a project. Students can form teams in Expertiza to work on various projects and assignments. Expertiza supports submission across various document types, including the URLs and wiki pages.

= Problem Statement: =
The topics page of the bidding shows bidding process and if assigned team for each project. There is no way for the instructor to know what percentage of teams got their first choice of project and which teams have bid on the projects.
Add a new feature which summaries the Bidding details,

=Previous Work=
*[[CSC/ECE_517_Fall_2023_-_E2360._View_for_Results_of_Bidding]]
*[[CSC/ECE_517_Spring_2022_-_E2245:_View_for_results_of_bidding]]

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

==Implemented Code==
'''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]]

*./app/models/assignment.rb
[[File:App-models-assignment.rb.jpg|frameless|upright=3]]

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

'''5. 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]]

*./app/views/assignments/bidding_details.html.erb
[[File:App-views-assignments-bidding details.jpg|frameless|upright=3]]

'''7. Bid Summary 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.

app/views/assignments/edit/_topics.html.erb
*./config/routes.rb
*./app/models/team.rb

==Code Changes==

= Use Case Diagram: =
=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]]

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

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

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

[[Category:Assignments]]

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

2024-03-24T17:47:12Z

Cpwalinj:

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

2024-03-24T17:27:28Z

Cpwalinj:

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

2024-03-24T16:39:52Z

Cpwalinj:

File:App-views-assignments-bidding details.jpg

2024-03-24T16:38:31Z

Cpwalinj:

File:App-views-assignments- bid summary partial.jpg

2024-03-24T16:34:32Z

Cpwalinj:

File:App-models-bid.rb.jpg

2024-03-24T16:31:51Z

Cpwalinj: