Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-27T15:25:54Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1200px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1200px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1200px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1200px|Add Signup Topics]]

'''Test:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 spec/helpers/sign_up_sheet_helper_spec.rb]

[[File:e2245-helper-testcase.png|1200px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

==== Test case for sign_up_sheet_helper ====

<pre>

describe '#get_team_bids' do
before(:each) do
@assignment1 = create(:assignment, name: 'final 1', directory_path: 'final_1')
@topic1 = create(:topic, assignment: @assignment1)
@assignment2 = create(:assignment, name: 'final 2', directory_path: 'final_2')
@topic2 = create(:topic, assignment: @assignment2)
@participant1 = create(:participant, assignment: @assignment1)
end

it 'The get_team_bids method return an empty string' do
out_string = helper.get_team_bids(@topic1, [@participant1])
expect(out_string).to be_nil
end

it 'The get_team_bids method should throw an exception' do
expect { helper.get_team_bids(@topic1, @assignment1, nil) }.to raise_exception(ArgumentError)
end
end

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-27T15:25:30Z

Dvnguye3: /* Test case for sign_up_sheet_helper */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1200px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1200px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1200px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1200px|Add Signup Topics]]

'''Test:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 spec/helpers/sign_up_sheet_helper_spec.rb]

[[File:e2245-helper-testcase.png|1200px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

==== Test case for sign_up_sheet_helper ====

<pre>

describe '#get_team_bids' do
before(:each) do
@assignment1 = create(:assignment, name: 'final 1', directory_path: 'final_1')
@topic1 = create(:topic, assignment: @assignment1)
@assignment2 = create(:assignment, name: 'final 2', directory_path: 'final_2')
@topic2 = create(:topic, assignment: @assignment2)
@participant1 = create(:participant, assignment: @assignment1)
end

it 'The get_team_bids method return an empty string' do
out_string = helper.get_team_bids(@topic1, [@participant1])
expect(out_string).to be_nil
end

it 'The get_team_bids method should throw an exception' do
expect { helper.get_team_bids(@topic1, @assignment1, nil) }.to raise_exception(ArgumentError)
end
end

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:E2245-helper-testcase.png

2022-04-27T15:24:46Z

Dvnguye3:

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-27T15:24:20Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1200px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1200px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1200px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1200px|Add Signup Topics]]

'''Test:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 spec/helpers/sign_up_sheet_helper_spec.rb]

[[File:e2245-helper-testcase.png|1200px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

==== Test case for sign_up_sheet_helper ====

<pre>

describe '#get_team_bids' do
before(:each) do
@assignment1 = create(:assignment, name: 'final 1', directory_path: 'final_1')
@topic1 = create(:topic, assignment: @assignment1)
@assignment2 = create(:assignment, name: 'final 2', directory_path: 'final_2')
@topic2 = create(:topic, assignment: @assignment2)
@participant1 = create(:participant, assignment: @assignment1)
end

it 'The get_team_bids method should not return an empty html' do
out_string = helper.get_team_bids(@topic1, @participant1)
expect(out_string).not_to be_empty
end

it 'The get_team_bids method should throw an exception' do
expect { helper.get_team_bids(@topic1, @assignment1, [@participant1]) }.to raise_exception(NoMethodError)
end
end

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-27T13:46:03Z

Dvnguye3: /* Testing */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1200px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1200px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1200px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1200px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

==== Test case for sign_up_sheet_helper ====

<pre>

describe '#get_team_bids' do
before(:each) do
@assignment1 = create(:assignment, name: 'final 1', directory_path: 'final_1')
@topic1 = create(:topic, assignment: @assignment1)
@assignment2 = create(:assignment, name: 'final 2', directory_path: 'final_2')
@topic2 = create(:topic, assignment: @assignment2)
@participant1 = create(:participant, assignment: @assignment1)
end

it 'The get_team_bids method should not return an empty html' do
out_string = helper.get_team_bids(@topic1, @participant1)
expect(out_string).not_to be_empty
end

it 'The get_team_bids method should throw an exception' do
expect { helper.get_team_bids(@topic1, @assignment1, [@participant1]) }.to raise_exception(NoMethodError)
end
end

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-27T13:43:57Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1200px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1200px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1200px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1200px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-26T03:53:42Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1200px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1200px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1200px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1200px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1200px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-26T03:53:06Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1200px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1200px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-26T03:52:02Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1921px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1921px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:Total-1-2-bids.png

2022-04-26T03:50:30Z

Dvnguye3: Dvnguye3 uploaded a new version of File:Total-1-2-bids.png

File:Total-bids.png

2022-04-26T03:49:50Z

Dvnguye3: Dvnguye3 uploaded a new version of File:Total-bids.png

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-26T03:48:37Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1000px|Total bids]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1000px|1-2 bids]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

[[File:e2245-signup-sheet-helper.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-26T03:46:32Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Helper:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/helpers/sign_up_sheet_helper.rb]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:E2245-signup-sheet-helper.png

2022-04-26T03:44:14Z

Dvnguye3:

File:Table-header.png

2022-04-26T03:43:59Z

Dvnguye3: Dvnguye3 uploaded a new version of File:Table-header.png

File:Table-line.png

2022-04-26T03:43:37Z

Dvnguye3: Dvnguye3 uploaded a new version of File:Table-line.png

File:Topic-names.png

2022-04-26T03:43:21Z

Dvnguye3:

File:Total-1-2-bids.png

2022-04-26T03:43:04Z

Dvnguye3: Dvnguye3 uploaded a new version of File:Total-1-2-bids.png

File:Total-bids.png

2022-04-26T03:42:49Z

Dvnguye3: Dvnguye3 uploaded a new version of File:Total-bids.png

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-26T03:33:05Z

Dvnguye3: /* Functionalities added */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

# [https://drive.google.com/file/d/1uSPnL0S0E2VqvTidk534pcv-2rX4dBtN/view?usp=sharing Here is the link to our recorded demo of the feature]
# The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:51:32Z

Dvnguye3: /* Track our works for transparency, collaboration and productivity */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:E2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:E2245-project-tasks.png

2022-04-24T20:50:55Z

Dvnguye3: Dvnguye3 uploaded a new version of File:E2245-project-tasks.png

File:E2245-project-tasks.png

2022-04-24T20:50:30Z

Dvnguye3: Dvnguye3 uploaded a new version of File:E2245-project-tasks.png

File:E2245-project-tasks.png

2022-04-24T20:47:05Z

Dvnguye3:

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:46:47Z

Dvnguye3: /* Improvement on the Previous Work */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Strategy to implement our plan to improve previous Works ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Track our works for transparency, collaboration and productivity ===

We've been working collaboratively to deliver this project as a team, by using Github Project feature to assign, track and collaborate our tasks. We've created an accompanying github project for this purpose, link can be found [https://github.com/dnguyenv/final-e2245/projects/1 here]

[[File:e2245-project-tasks.png|1200px|project tasks]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:38:36Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_1_2_bids.html.erb]

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_actions.html.erb]

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_add_signup_topics.html.erb]

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_header.html.erb]

[[File:table-header.png|1000px|Add Signup Topics]]

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_table_line.html.erb]

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:37:40Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*[https://github.com/expertiza/expertiza/pull/2392/files#diff-5df8b9300332120367b2b5930ef57a17907270e3705e7ed90e0f5f825f335449 app/views/sign_up_sheet/_total_bids.html.erb]

[[File:total-bids.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_total_1_2_bids.html.erb

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:33:15Z

Dvnguye3: /* Project Goal */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code as needed
* Increase test coverage as appropriate

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb

[[File:total-bids.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_total_1_2_bids.html.erb

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:31:27Z

Dvnguye3: /* Future Work */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb

[[File:total-bids.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_total_1_2_bids.html.erb

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==

Because of the time constraints, we could only implement that much of features and would like to layout some potential future works need to be done:

# More testing for edge-cases
# Add automatic test for UIs

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:Assignment-topics.png

2022-04-24T20:26:29Z

Dvnguye3:

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:26:10Z

Dvnguye3: /* Functionalities added */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb

[[File:total-bids.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_total_1_2_bids.html.erb

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

[[File:assignment-topics.png|1200px|Assignment Topics View]]

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:25:03Z

Dvnguye3: /* Functionalities added */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb

[[File:total-bids.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_total_1_2_bids.html.erb

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

Here is the screenshot of real app running that shows what the Instructor will see in Assignment >> Topic view:

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:22:46Z

Dvnguye3: /* Testing */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb

[[File:total-bids.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_total_1_2_bids.html.erb

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==

=== Manual UI testing for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View total bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular assignment: SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id
# Once the Topics page shows up, verify the bidding details (total number of bids) for each Topic on the table

Example:

<pre>

mysql> SELECT topic_id as topic_id, COUNT(b.topic_id) as count FROM sign_up_topics t JOIN bids b ON t.id = b.topic_id WHERE t.assignment_id = 834 GROUP BY t.id;
+----------+-------+
| topic_id | count |
+----------+-------+
| 3918 | 29 |
| 3919 | 14 |
| 3920 | 12 |
| 3921 | 29 |
| 3922 | 19 |
| 3923 | 13 |
| 3924 | 14 |
| 3925 | 15 |
| 3926 | 11 |
| 3927 | 10 |
| 3928 | 9 |
| 3929 | 6 |
| 3930 | 7 |
| 3931 | 8 |
| 3932 | 5 |
| 3933 | 7 |
| 3934 | 17 |
| 3935 | 12 |
| 3936 | 4 |
| 3937 | 19 |
| 3938 | 10 |
+----------+-------+
21 rows in set (0.00 sec)

</pre>

==== View total of #1 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 1 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of #1 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 1 and topic_id=3918;
+----------+
| count(*) |
+----------+
| 10 |
+----------+
1 row in set (0.00 sec)

</pre>

==== View total of #2 bids for a topic ====
# Log into expertiza as Instructor
# Go to Assignments >> Topics page/tab
# Execute this query against the application database to get the total number of bids for each topic for a particular topic: select * from bids where priority = 2 and topic_id=3918;
# Once the Topics page shows up, verify the bidding details (total number of # 2 bids) for each Topic on the table

Example:

<pre>

mysql> select count(*) from bids where priority = 2 and topic_id=3921;
+----------+
| count(*) |
+----------+
| 6 |
+----------+
1 row in set (0.00 sec)

</pre>

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:Total-1-2-bids.png

2022-04-24T20:08:02Z

Dvnguye3:

File:Total-bids.png

2022-04-24T20:07:50Z

Dvnguye3:

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:07:36Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb

[[File:total-bids.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_total_1_2_bids.html.erb

[[File:total-1-2-bids.png|1000px|Add Signup Topics]]

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:e2245-actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:E2245-actions.png

2022-04-24T20:05:21Z

Dvnguye3:

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:03:46Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb
*app/views/sign_up_sheet/_total_1_2_bids.html.erb

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb

[[File:actions.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:Table-line.png

2022-04-24T20:02:50Z

Dvnguye3:

File:Table-header.png

2022-04-24T20:02:34Z

Dvnguye3:

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T20:02:14Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb
*app/views/sign_up_sheet/_total_1_2_bids.html.erb

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb

[[File:table-header.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_line.html.erb

[[File:table-line.png|1000px|Add Signup Topics]]

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T19:57:26Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb
*app/views/sign_up_sheet/_total_1_2_bids.html.erb

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|1000px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb
*app/views/sign_up_sheet/_table_line.html.erb

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T19:57:11Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made (We also added links to our Github commits for each change so that the reviewers can link directly to github for more in-depth inspection/review)

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb
*app/views/sign_up_sheet/_total_1_2_bids.html.erb

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|800px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb
*app/views/sign_up_sheet/_table_line.html.erb

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

File:Add-signup-topics.png

2022-04-24T19:54:49Z

Dvnguye3: Dvnguye3 uploaded a new version of File:Add-signup-topics.png

File:Add-signup-topics.png

2022-04-24T19:53:57Z

Dvnguye3:

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T19:53:37Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made:

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb
*app/views/sign_up_sheet/_total_1_2_bids.html.erb

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb

[[File:add-signup-topics.png|800px|Add Signup Topics]]

*app/views/sign_up_sheet/_table_header.html.erb
*app/views/sign_up_sheet/_table_line.html.erb

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T19:51:17Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made:

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb
*app/views/sign_up_sheet/_total_1_2_bids.html.erb

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb

*app/views/sign_up_sheet/_table_header.html.erb
*app/views/sign_up_sheet/_table_line.html.erb

'''Configuration:'''

*config/locales/en_US.yml

*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-24T19:36:56Z

Dvnguye3: /* Code changes */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

From preliminary research, we believed we would need to add and modify, refactor code from almost all layers of the features (including Controllers, Models, Views but we end up decided to focus on delivering the feature with minimum code changes and regression tests, so majority of our code changes are on Views layer. Following are the changes we made:

'''New Files added:'''

*app/views/sign_up_sheet/_total_bids.html.erb
*app/views/sign_up_sheet/_total_1_2_bids.html.erb

'''Files changed:'''

'''View:'''

*app/views/sign_up_sheet/_actions.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_header.html.erb
*app/views/sign_up_sheet/_table_line.html.erb

'''Configuration:'''

*config/locales/en_US.yml
*config/locales/hi_IN.yml

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-22T17:55:44Z

Dvnguye3: /* Class Diagram */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1000px|Class diagram]]

=== Code changes ===

The following files will be changed to fulfill the requirements

'''Controllers''':
*app/controllers/sign_up_sheet_controller.rb
*app/controllers/review_bids_controller.rb
*app/controllers/lottery_controller.rb

'''Models''':
*app/models/bid.rb

 
'''Views''':
*app/views/sign_up_sheet/list.html.erb
*app/views/assigments/edit/_topics.html.erb
 

'''Rspec''':
*spec/controllers/sign_up_sheet_controller_spec.rb
*spec/controllers/big_spec.rb
*spec/controllers/review_bids_controller_spec.rb
*spec/controllers/lottery_controller_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
# Rename method names more meaningfully and intuitive.

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]

CSC/ECE 517 Spring 2022 - E2245: View for results of bidding

2022-04-22T17:55:29Z

Dvnguye3: /* Change in Work Flow Diagram */

'''CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
'''
== Problem Statement ==

When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.

== Project Goal ==
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
* Maximize useful information at a glance, while minimizing clutter
* Fit into the flow of the topic page
* Allow further information to be obtained if requested
* Not be visible if bidding is not used

Some other miscellaneous goals of this project are to:
* Remove topic fields from view if they are not applicable
* Refactor code
* Increase test coverage

== Previous Work ==

=== Current User Cases ===

Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.

[[File:old-usecases.png|800px|Old user cases]]

=== Current Work Flow Diagram ===

As an Instructor, the user after, being authenticated, needs to go to the Assignments >> Topics view to create the topics/projects and then once the bidding started, needs to impersonate a student to partially (at very minimal level) get the bidding process information

[[File:Old-flow.png|600px|Old user cases]]

== Improvement on the Previous Work ==

=== Change in Use Cases ===

[[File:new-usecases.png|800px|Old user cases]]

'''Student''': This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism. 

'''Instructor''': This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students

=== UI design ===

The existing view with very limited information about the bidding process

'''Before''':

[[File:before-bidding.png|1200px|Popup prototype]]

With this proposed new view, the Instructor can gain a more complete view of the whole bidding process in one place.

'''Proposed UI'''

[[File:after-bidding.png|1200px|Popup prototype]]

=== Change in Work Flow Diagram ===

With the new flow and implementation, the Instructor now can have all (complete) information he/she needs in one place at the Topics list/details view instead of having to impersonate a student to get even some minimal, un-completed piece of information about the bidding.

[[File:new-flow.png|600px|Old user cases]]

=== Class Diagram ===

[[File:class-diagram.png|1200px|Class diagram]]

=== Code changes ===

The following files will be changed to fulfill the requirements

'''Controllers''':
*app/controllers/sign_up_sheet_controller.rb
*app/controllers/review_bids_controller.rb
*app/controllers/lottery_controller.rb

'''Models''':
*app/models/bid.rb

 
'''Views''':
*app/views/sign_up_sheet/list.html.erb
*app/views/assigments/edit/_topics.html.erb
 

'''Rspec''':
*spec/controllers/sign_up_sheet_controller_spec.rb
*spec/controllers/big_spec.rb
*spec/controllers/review_bids_controller_spec.rb
*spec/controllers/lottery_controller_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
# Rename method names more meaningfully and intuitive.

== Functionalities added ==

* The instructor should be able to see how many teams have bid for each topic without having to impersonate students 

== Testing ==
=== Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) ===

<pre>
describe '#create' do
context 'when topic cannot be found' do
context 'when new topic can be saved successfully' do
it 'sets up a new topic and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
max_choosers: 1,
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
end
end

context 'when new topic cannot be saved successfully' do
it 'sets up a new topic and renders sign_up_sheet#new page' do
allow(SignUpTopic).to receive(:where).with(topic_name: 'Hello world!', assignment_id: '1').and_return([nil])
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been created successfully. ').and_return('OK')
allow(topic).to receive(:save).and_return('OK')
request_params = {
id: 1,
topic: {
topic_identifier: 1,
topic_name: 'Hello world!',
category: '',
micropayment: 1
}
}
post :create, params: request_params
expect(response).to render_template(:new)
end
end
end

context 'when topic can be found' do
it 'updates the existing topic and redirects to sign_up_sheet#add_signup_topics_staggered page' do
allow(SignedUpTeam).to receive(:find_by).with(topic_id: 1).and_return(signed_up_team)
allow(SignedUpTeam).to receive(:where).with(topic_id: 1, is_waitlisted: true).and_return([signed_up_team2])
allow(Team).to receive(:find).with(2).and_return(team)
allow(SignUpTopic).to receive(:find_waitlisted_topics).with(1, 2).and_return(nil)
request_params = {
id: 1,
topic: {
topic_identifier: 666,
topic_name: 'Hello world!',
max_choosers: 2,
category: '666',
micropayment: 1
}
}
post :create, params: request_params
expect(SignedUpTeam.first.is_waitlisted).to be false
expect(response).to redirect_to('/sign_up_sheet/add_signup_topics_staggered?id=1')
end
end
end

describe '#destroy' do
context 'when topic can be found' do
it 'redirects to assignment#edit page' do
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(response).to redirect_to('/assignments/1/edit')
end
end

context 'when topic cannot be found' do
it 'shows an error flash message and redirects to assignment#edit page' do
allow(SignUpTopic).to receive(:find).with('1').and_return(nil)
allow_any_instance_of(SignUpSheetController).to receive(:undo_link)
.with('The topic: "Hello world!" has been successfully deleted. ').and_return('OK')
request_params = { id: 1, assignment_id: 1 }
post :destroy, params: request_params
expect(flash[:error]).to eq('The topic could not be deleted.')
expect(response).to redirect_to('/assignments/1/edit')
end
end
end
</pre>

=== Test the UI for the deployed project. ===

==== UI Testing ====
'''Instructor View''' 
* username: instructor6 
* password: password 

'''Student View''' 
* username: student575 
* password: password 

==== View bidding details ====
# Log into expertiza as Instructor
# Go to Topics page
# Once the Topics page shows up, verify the bidding details for each Topic on the table
# Impersonate a Student to verify if the team/student was actually bidding for the Topic

== Future Work ==
* Place holder for potential ed-cases that might get missed

==Team Roster ==

Mentor: Ed Gehringer - efg@ncsu.edu

*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn Salekin - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

== Reference ==
#[https://docs.google.com/document/d/1tyWX8njxDLvYpN7wJf5hjA6lnWbzQRP9vUKGxxRjRzo/edit?pli=1#heading=h.5cgh9aixuut7 Previous works]
#[https://github.com/dnguyenv/expertiza/tree/beta Team code repo]
#[https://github.com/expertiza/expertiza/tree/beta Upstream code repo]