Expertiza_Wiki - User contributions [en]

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

2022-04-07T01:54:42Z

Ssaleki: /* UI 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 ==

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

# Option 1: Add new columns to the existing table, and to make space for it we can dynamically remove the "Bookmark" and "Ads" (Advertisements) columns depending on the specific circumstance.

[[File:updated_table.png|800px|Popup prototype]]

# Option2: View bidding details in an expanded/collapsed style. This is similar to peer review tables. (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

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

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

''Note: please double check the credentials''

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

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

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T01:53:44Z

Ssaleki: /* UI 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 ==

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

# Option 1: Add new columns to the existing table, and to make space for it we can dynamically remove the "Bookmark" and "Ads" (Advertisements) columns depending on the specific circumstance.

[[File:updated_table.png|800px|Popup prototype]]

# Option2: View bidding details in an expanded/collapsed style. This is similar to peer review tables. (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

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

Student View: 
* username: student575 
* password: password 

_Note to the team_: please double check the credentials

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

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

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T01:49:01Z

Ssaleki: /* 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
* Increase test coverage

== Previous Work ==

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

# Option 1: Add new columns to the existing table, and to make space for it we can dynamically remove the "Bookmark" and "Ads" (Advertisements) columns depending on the specific circumstance.

[[File:updated_table.png|800px|Popup prototype]]

# Option2: View bidding details in an expanded/collapsed style. This is similar to peer review tables. (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

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

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T01:48:19Z

Ssaleki:

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

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

# Option 1: Add new columns to the existing table, and to make space for it we can dynamically remove the "Bookmark" and "Ads" (Advertisements) columns depending on the specific circumstance.

[[File:updated_table.png|800px|Popup prototype]]

# Option2: View bidding details in an expanded/collapsed style. This is similar to peer review tables. (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

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

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T01:47:04Z

Ssaleki: /* UI design */

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

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

# Option 1: Add new columns to the existing table, and to make space for it we can dynamically remove the "Bookmark" and "Ads" (Advertisements) columns depending on the specific circumstance.

[[File:updated_table.png|800px|Popup prototype]]

# Option2: View bidding details in an expanded/collapsed style. This is similar to peer review tables. (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T01:43:35Z

Ssaleki: /* UI design */

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

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

# Option 1: Add new columns to the existing table, and to make space for it we can dynamically remove the "Bookmark" and "Ads" (Advertisements) columns depending on the specific circumstance.

[[File:updated_table.png|800px|Popup prototype]]

# Option2: View bidding details in an expanded/collapsed style (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T01:43:12Z

Ssaleki: /* UI design */

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

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

#Option 1: Add new columns to the existing table, and to make space for it we can
dynamically remove the "Bookmark" and "Ads" (Advertisements) columns depending on the
specific circumstance.

[[File:updated_table.png|800px|Popup prototype]]

#Option2: View bidding details in an expanded/collapsed style (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T01:40:32Z

Ssaleki: /* UI design */

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

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

#Option 1: Details in a popup window

[[File:updated_table.png|800px|Popup prototype]]

#Option2: View bidding details in a expanded/collapsed style (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

File:Updated table.png

2022-04-07T01:39:38Z

Ssaleki:

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

2022-04-07T00:40:23Z

Ssaleki: /* Problem Statement */

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

== Problem Statement ==

When topics are opened up for bidding, students can see how “hot” each topic is by the color it has on their topic list. However, instructors have no way to view the bidding process except by impersonating students. Furthermore, when the bidding assignment algorithm is run, there is no way to verify that it did in fact assign teams to topics they had chosen.

Edit
- individuals reserve before teams are formed

Soln
- Use heuristics instead of an NP-complete algorithm
- More weight on larger group

== Project Goal ==

The goal of this project is to create a field for instructors on the topic list that shows how many teams have bid for each project. Since topic lines in the topic list potentially have several fields, including partner advertisements, take care that
# the #-of-bids field is not displayed except for projects that use bidding for topics, and
# the field is as narrow as feasible.
Emphasis is placed on the UX design to allow instructors to quickly verify that the bidding algorithm gave as many teams as possible their first choice.

== Previous Work ==

=== User Cases ===

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

#Option 1: Details in a popup window

[[File:Design-popup1.png|800px|Popup prototype]]

#Option2: View bidding details in a expanded/collapsed style (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T00:40:02Z

Ssaleki: /* Problem Statement */

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

== Problem Statement ==

When topics are opened up for bidding, students can see how “hot” each topic is by the color it has on their topic list. However, instructors have no way to view the bidding process except by impersonating students. Furthermore, when the bidding assignment algorithm is run, there is no way to verify that it did in fact assign teams to topics they had chosen.

Edit
- individuals reserve before teams are performed

Soln
- Use heuristics instead of an NP-complete algorithm
- More weight on larger group

== Project Goal ==

The goal of this project is to create a field for instructors on the topic list that shows how many teams have bid for each project. Since topic lines in the topic list potentially have several fields, including partner advertisements, take care that
# the #-of-bids field is not displayed except for projects that use bidding for topics, and
# the field is as narrow as feasible.
Emphasis is placed on the UX design to allow instructors to quickly verify that the bidding algorithm gave as many teams as possible their first choice.

== Previous Work ==

=== User Cases ===

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

#Option 1: Details in a popup window

[[File:Design-popup1.png|800px|Popup prototype]]

#Option2: View bidding details in a expanded/collapsed style (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T00:39:17Z

Ssaleki: /* Problem Statement */

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

== Problem Statement ==

When topics are opened up for bidding, students can see how “hot” each topic is by the color it has on their topic list. However, instructors have no way to view the bidding process except by impersonating students. Furthermore, when the bidding assignment algorithm is run, there is no way to verify that it did in fact assign teams to topics they had chosen.

Edit
- individuals reserve before teams are performed

Soln
- Use heuristics instead of an NP-complete algorithm

== Project Goal ==

The goal of this project is to create a field for instructors on the topic list that shows how many teams have bid for each project. Since topic lines in the topic list potentially have several fields, including partner advertisements, take care that
# the #-of-bids field is not displayed except for projects that use bidding for topics, and
# the field is as narrow as feasible.
Emphasis is placed on the UX design to allow instructors to quickly verify that the bidding algorithm gave as many teams as possible their first choice.

== Previous Work ==

=== User Cases ===

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

#Option 1: Details in a popup window

[[File:Design-popup1.png|800px|Popup prototype]]

#Option2: View bidding details in a expanded/collapsed style (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

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

2022-04-07T00:33:26Z

Ssaleki:

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

== Problem Statement ==

When topics are opened up for bidding, students can see how “hot” each topic is by the color it has on their topic list. However, instructors have no way to view the bidding process except by impersonating students. Furthermore, when the bidding assignment algorithm is run, there is no way to verify that it did in fact assign teams to topics they had chosen.

== Project Goal ==

The goal of this project is to create a field for instructors on the topic list that shows how many teams have bid for each project. Since topic lines in the topic list potentially have several fields, including partner advertisements, take care that
# the #-of-bids field is not displayed except for projects that use bidding for topics, and
# the field is as narrow as feasible.
Emphasis is placed on the UX design to allow instructors to quickly verify that the bidding algorithm gave as many teams as possible their first choice.

== Previous Work ==

=== User Cases ===

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

=== Design Pattern ===

In-progress of documenting the utilized design patterns

=== Work Flow Diagram ===

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

#Option 1: Details in a popup window

[[File:Design-popup1.png|800px|Popup prototype]]

#Option2: View bidding details in a expanded/collapsed style (Preferred)

=== Change in Work Flow Diagram ===

<Flow diagram to come>

=== Code changes ===

The following files will be changed to fulfill the requirements

Controllers:
*app/controllers/sign_up_sheet_controller.rb

Models:
*app/models/bid.rb

 
Views:
*app/views/sign_up_sheet/list.html.erb
 

Rspec:
*spec/controller/sign_up_sheet_controller_spec.rb
*spec/controller/big_spec.rb
 

'''Refactor Code to follow good coding practices''' 
Example: 
1. Rename method names more meaningfully and intuitive.

'''Correct Previous Design''' 

1. Remove mentors from being included in a team's number of members count. 

'''BEFORE''' 

'''AFTER''' 

'''Code placed in the wrong locations to be moved to the desired locations.''' 
Example: 
# Example here

== Functionalities added ==

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

== Testing ==
# Some existing test cases have been modified, which have been reverted. 
# Run and pass the existing RSpec Tests. 
# Test the UI for the deployed project. 

== UI Testing ==
Part 1: 
* Login as the instructor6 

Part 2: 
* Login as student575 (added to the program by the instructor) 

== Future Work ==
* If a mentor is removed from an assignment, reassignment of mentor has to be done. (edge-case)
* Rspec for email functionality needs to be implemented.

==Team Roster ==
*Duy Nguyen - dvnguye3@ncsu.edu 
*Kwon HyeokJun - khyeokj@ncsu.edu 
*Shawn S - ssaleki@ncsu.edu 
*David Glymph - dwglymph@ncsu.edu 

Mentor: Ed Gehringer - efg@ncsu.edu

== Reference ==
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1994._Mentor_management_for_assignments_without_topics Previous Work]

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-24T20:33:56Z

Ssaleki:

== Background ==
The later policies controller file manages the SCRUM from late policies. Chiefly, the file checks if new or updated late policies are valid policies, in that they do not have the same name as an already existing policy, does not have a late penatly per unit time that surpasses the max late penalty, and does not have a late penalty surpassing 100.

=== Team Members ===

* Wyatt Plaga (wgplaga@ncsu.edu)
* Sujith Tumma (stumma2@ncsu.edu)
* Shawn Salekin (ssaleki@ncsu.edu)

== Description about project ==
This wiki describes the work done to refactor late_policies_controller.rb. The main focus of the work went into removing code duplication, as well as simplifying the code for readability, for the create and update methods. This also includes adding code comments for understandibility.

=== Files Involved ===

File Modified:
* app/controllers/late_policies_controller.rb
* app/views/late_policies/new.html.erb
* app/views/late_policies/_form.html.erb
* spec/controllers/late_policies_controller_spec.rb
* db/schema.rb

File Added:
* db/migrate/20220321162332_add_private_to_late_policies.rb

== Test Plan ==

This is a refactoring project, so performed manual tests to ensure the functionalities did not change.
Here is how you can test it manually.
* Navigate over to the late policies index page: http://152.7.98.82:9090/late_policies
* Create a new policy. Try different input combinations, some valid or invalid. Keep an eye for the error messages
* Try updating the policy
* Try giving the same name to two different policies and see if you get proper error message
* Delete policies.
* Additionally, if you are able to login as a different instructor, you should not see someone else's privately created
policies.

If all of these changes work as intended, we should be good.

==Code Issues==

1. All the late policies will show up on the index page, not just policies created by the current instructor. Need to create public & private late policies. Try to leverage code for private and public courses, assignments, and questionnaires.

2. create and update have some duplicate code. Fix that using a partial, _form.

3. Both create and update need comments and a better identifier naming.

4. Reduce code duplication. Find a way to make the code more DRY

5. Line 64: The if condition can be simplified.

6. Improve the variable name for same_policy_name. (Boolean variables can be named in a better way)

7. Add method comments

8. Find the use of instance variables in create and update method? Do we really need it? Can it be made local variables instead?

==Code Changes==

1. All the late policies will show up on the index page, not just policies created by the current instructor. Need to create public & private late policies. Try to leverage code for private and public courses, assignments, and questionnaires

Current code:
<pre>
(No such code exists)
</pre>

Modifications:
<pre>
- add a column named 'private' on to the LatePolicy model
- In the controller#index method, filter the results by private != 0 or instructor_id = current_user_id

</pre>

2. create and update have some duplicate code. Fix that using a partial, _form.

Filename: app/views/late_policies/new.html.erb

Current Code:
<pre>
<%= form_for @late_policy, :url => { :action => "create" } do |f| %>
<%= error_messages_for @late_policy %>


<label for="late_policy_name">Late policy name:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'policy_name' %>


<label for="late_policy_penalty_points_per_unit">Penalty points per unit:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'penalty_per_unit' %>


<label for="penalty_unit">Penalty unit:</label><label style="color: #ff0000;">*</label> 

<% @units= %w[Minute Hour Day]%>
<%= f.select "penalty_unit", @units %>


<label for="late_policy_penalty_maximum">Maximum penalty:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'max_penalty' %>

</pre>

Modifications:
<pre>
<%= form_for @penalty_policy, :url => { :action => "create" } do |f| %>
<%= error_messages_for @penalty_policy %>
<%= render partial: 'form', locals: { f: f } %>
</pre>

3. Both create and update need comments and a better identifier naming.

Current identifiers names:
<pre>
* invalid_penalty_per_unit (Problem with this is ,try to read "!invalid_penalty_per_unit". So, "valid_penalty" increases the readability. )
* policy_name_exists
</pre>

Modifications:
<pre>
Got rid of both identifier names and implemented functions that validate input and check the duplicity of late policy name
* valid_penalty
* duplicate_name_check

</pre>

4. Reduce code duplication. Find a way to make the code more DRY

Extracted the validation done in both create and update into a seperate method. This reduced repition between the two methods. See part 5.

5. Line 64: The if condition can be simplified.

Origional Code:
<pre>
invalid_penalty_per_unit = params[:late_policy][:max_penalty].to_i < params[:late_policy][:penalty_per_unit].to_i
flash[:error] = 'The maximum penalty cannot be less than penalty per unit.' if invalid_penalty_per_unit
same_policy_name = false
# penalty name should be unique
if same_policy_name != LatePolicy.check_policy_with_same_name(params[:late_policy][:policy_name], instructor_id)
flash[:error] = 'A policy with the same name already exists.'
same_policy_name = true
end
# maximum penalty cannot be greater than equal to 100
if params[:late_policy][:max_penalty].to_i >= 100
flash[:error] = 'Maximum penalty cannot be greater than or equal to 100'
invalid_max_penalty = true
end

if !invalid_penalty_per_unit && !same_policy_name && !invalid_max_penalty
@late_policy = LatePolicy.new(late_policy_params)
@late_policy.instructor_id = instructor_id
begin
@late_policy.save!
flash[:notice] = 'The late policy was successfully created.'
redirect_to action: 'index'
rescue StandardError
flash[:error] = 'The following error occurred while saving the late policy: '
redirect_to action: 'new'
end
else
redirect_to action: 'new'
end
</pre>

Modifications:
<pre>
def validate_input(is_update=false)
# Validates input for create and update forms
max_penalty = params[:late_policy][:max_penalty].to_i
penalty_per_unit = params[:late_policy][:penalty_per_unit].to_i

valid_penalty, error_message = true, nil
valid_penalty, error_message = duplicate_name_check(is_update)
prefix = is_update ? "Cannot edit the policy. " : ""

#This check validates the maximum penalty.
if max_penalty < penalty_per_unit
error_message = prefix + 'The maximum penalty cannot be less than penalty per unit.'
valid_penalty = false
end

#This check validates the penalty per unit for a late policy.
if penalty_per_unit < 0
error_message = 'Penalty per unit cannot be negative.'
valid_penalty = false
end

# This checks maximum penalty does not exceed 100.
if max_penalty >= 100
error_message = prefix + 'Maximum penalty cannot be greater than or equal to 100'
valid_penalty = false
end

return valid_penalty, error_message
end

</pre>

6. Improve the variable name for same_policy_name. (Boolean variables can be named in a better way)

Current identifiers names:
<pre>
same_policy_name
</pre>

Modifications:
<pre>
Got rid of this identifier by replacing it with a function named "duplicate_name_check"
</pre>

7. Add method comments
<pre>
No comments
</pre>

Modifications:
<pre>
Added comments for all the methods to increase the readability of the code.
</pre>

==GitHub links==

Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/Wyatt-Plaga/expertiza-1 here]

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-24T20:33:08Z

Ssaleki:

== Background ==
The later policies controller file manages the SCRUM from late policies. Chiefly, the file checks if new or updated late policies are valid policies, in that they do not have the same name as an already existing policy, does not have a late penatly per unit time that surpasses the max late penalty, and does not have a late penalty surpassing 100.

=== Team Members ===

* Wyatt Plaga (wgplaga@ncsu.edu)
* Sujith Tumma (stumma2@ncsu.edu)
* Shawn Salekin (ssaleki@ncsu.edu)

== Description about project ==
This wiki describes the work done to refactor late_policies_controller.rb. The main focus of the work went into removing code duplication, as well as simplifying the code for readability, for the create and update methods. This also includes adding code comments for understandibility.

=== Files Involved ===

File Modified:
* app/controllers/late_policies_controller.rb
* app/views/late_policies/new.html.erb
* app/views/late_policies/_form.html.erb
* spec/controllers/late_policies_controller_spec.rb
* db/schema.rb

File Added:
* db/migrate/20220321162332_add_private_to_late_policies.rb

== Test Plan ==

This is a refactoring project, so performed manual tests to ensure the functionalities did not change.
Here is how you can test it manually.
1. Navigate over to the late policies index page: http://152.7.98.82:9090/late_policies
2. Create a new policy. Try different input combinations, some valid or invalid. Keep an eye for the error messages
3. Try updating the policy
4. Try giving the same name to two different policies and see if you get proper error message
5. Delete policies.
6. Additionally, if you are able to login as a different instructor, you should not see someone else's privately created
policies.

If all of these changes work as intended, we should be good.

==Code Issues==

1. All the late policies will show up on the index page, not just policies created by the current instructor. Need to create public & private late policies. Try to leverage code for private and public courses, assignments, and questionnaires.

2. create and update have some duplicate code. Fix that using a partial, _form.

3. Both create and update need comments and a better identifier naming.

4. Reduce code duplication. Find a way to make the code more DRY

5. Line 64: The if condition can be simplified.

6. Improve the variable name for same_policy_name. (Boolean variables can be named in a better way)

7. Add method comments

8. Find the use of instance variables in create and update method? Do we really need it? Can it be made local variables instead?

==Code Changes==

1. All the late policies will show up on the index page, not just policies created by the current instructor. Need to create public & private late policies. Try to leverage code for private and public courses, assignments, and questionnaires

Current code:
<pre>
(No such code exists)
</pre>

Modifications:
<pre>
- add a column named 'private' on to the LatePolicy model
- In the controller#index method, filter the results by private != 0 or instructor_id = current_user_id

</pre>

2. create and update have some duplicate code. Fix that using a partial, _form.

Filename: app/views/late_policies/new.html.erb

Current Code:
<pre>
<%= form_for @late_policy, :url => { :action => "create" } do |f| %>
<%= error_messages_for @late_policy %>


<label for="late_policy_name">Late policy name:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'policy_name' %>


<label for="late_policy_penalty_points_per_unit">Penalty points per unit:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'penalty_per_unit' %>


<label for="penalty_unit">Penalty unit:</label><label style="color: #ff0000;">*</label> 

<% @units= %w[Minute Hour Day]%>
<%= f.select "penalty_unit", @units %>


<label for="late_policy_penalty_maximum">Maximum penalty:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'max_penalty' %>

</pre>

Modifications:
<pre>
<%= form_for @penalty_policy, :url => { :action => "create" } do |f| %>
<%= error_messages_for @penalty_policy %>
<%= render partial: 'form', locals: { f: f } %>
</pre>

3. Both create and update need comments and a better identifier naming.

Current identifiers names:
<pre>
* invalid_penalty_per_unit (Problem with this is ,try to read "!invalid_penalty_per_unit". So, "valid_penalty" increases the readability. )
* policy_name_exists
</pre>

Modifications:
<pre>
Got rid of both identifier names and implemented functions that validate input and check the duplicity of late policy name
* valid_penalty
* duplicate_name_check

</pre>

4. Reduce code duplication. Find a way to make the code more DRY

Extracted the validation done in both create and update into a seperate method. This reduced repition between the two methods. See part 5.

5. Line 64: The if condition can be simplified.

Origional Code:
<pre>
invalid_penalty_per_unit = params[:late_policy][:max_penalty].to_i < params[:late_policy][:penalty_per_unit].to_i
flash[:error] = 'The maximum penalty cannot be less than penalty per unit.' if invalid_penalty_per_unit
same_policy_name = false
# penalty name should be unique
if same_policy_name != LatePolicy.check_policy_with_same_name(params[:late_policy][:policy_name], instructor_id)
flash[:error] = 'A policy with the same name already exists.'
same_policy_name = true
end
# maximum penalty cannot be greater than equal to 100
if params[:late_policy][:max_penalty].to_i >= 100
flash[:error] = 'Maximum penalty cannot be greater than or equal to 100'
invalid_max_penalty = true
end

if !invalid_penalty_per_unit && !same_policy_name && !invalid_max_penalty
@late_policy = LatePolicy.new(late_policy_params)
@late_policy.instructor_id = instructor_id
begin
@late_policy.save!
flash[:notice] = 'The late policy was successfully created.'
redirect_to action: 'index'
rescue StandardError
flash[:error] = 'The following error occurred while saving the late policy: '
redirect_to action: 'new'
end
else
redirect_to action: 'new'
end
</pre>

Modifications:
<pre>
def validate_input(is_update=false)
# Validates input for create and update forms
max_penalty = params[:late_policy][:max_penalty].to_i
penalty_per_unit = params[:late_policy][:penalty_per_unit].to_i

valid_penalty, error_message = true, nil
valid_penalty, error_message = duplicate_name_check(is_update)
prefix = is_update ? "Cannot edit the policy. " : ""

#This check validates the maximum penalty.
if max_penalty < penalty_per_unit
error_message = prefix + 'The maximum penalty cannot be less than penalty per unit.'
valid_penalty = false
end

#This check validates the penalty per unit for a late policy.
if penalty_per_unit < 0
error_message = 'Penalty per unit cannot be negative.'
valid_penalty = false
end

# This checks maximum penalty does not exceed 100.
if max_penalty >= 100
error_message = prefix + 'Maximum penalty cannot be greater than or equal to 100'
valid_penalty = false
end

return valid_penalty, error_message
end

</pre>

6. Improve the variable name for same_policy_name. (Boolean variables can be named in a better way)

Current identifiers names:
<pre>
same_policy_name
</pre>

Modifications:
<pre>
Got rid of this identifier by replacing it with a function named "duplicate_name_check"
</pre>

7. Add method comments
<pre>
No comments
</pre>

Modifications:
<pre>
Added comments for all the methods to increase the readability of the code.
</pre>

==GitHub links==

Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/Wyatt-Plaga/expertiza-1 here]

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-24T20:31:13Z

Ssaleki:

== Background ==
The later policies controller file manages the SCRUM from late policies. Chiefly, the file checks if new or updated late policies are valid policies, in that they do not have the same name as an already existing policy, does not have a late penatly per unit time that surpasses the max late penalty, and does not have a late penalty surpassing 100.

=== Team Members ===

* Wyatt Plaga (wgplaga@ncsu.edu)
* Sujith Tumma (stumma2@ncsu.edu)
* Shawn Salekin (ssaleki@ncsu.edu)

== Description about project ==
This wiki describes the work done to refactor late_policies_controller.rb. The main focus of the work went into removing code duplication, as well as simplifying the code for readability, for the create and update methods. This also includes adding code comments for understandibility.

=== Files Involved ===

File Modified:
* app/controllers/late_policies_controller.rb
* app/views/late_policies/new.html.erb
* app/views/late_policies/_form.html.erb
* spec/controllers/late_policies_controller_spec.rb
* db/schema.rb

File Added:
* db/migrate/20220321162332_add_private_to_late_policies.rb

=== Test Plan ===

This is a refactoring project, so performed manual tests to ensure the functionalities did not change.
Here is how you can test it manually.
1. Navigate over to the late policies index page: http://152.7.98.82:9090/late_policies
2. Create a new policy. Try different input combinations, some valid or invalid. Keep an eye for the error messages
3. Try updating the policy
4. Try giving the same name to two different policies and see if you get proper error message
5. Delete policies.
6. Additionally, if you are able to login as a different instructor, you should not see someone else's privately created
policies.

If all of these changes work as intended, we should be good.

==Code Issues==

1. All the late policies will show up on the index page, not just policies created by the current instructor. Need to create public & private late policies. Try to leverage code for private and public courses, assignments, and questionnaires.

2. create and update have some duplicate code. Fix that using a partial, _form.

3. Both create and update need comments and a better identifier naming.

4. Reduce code duplication. Find a way to make the code more DRY

5. Line 64: The if condition can be simplified.

6. Improve the variable name for same_policy_name. (Boolean variables can be named in a better way)

7. Add method comments

8. Find the use of instance variables in create and update method? Do we really need it? Can it be made local variables instead?

==Code Changes==

1. All the late policies will show up on the index page, not just policies created by the current instructor. Need to create public & private late policies. Try to leverage code for private and public courses, assignments, and questionnaires

Current code:
<pre>
(No such code exists)
</pre>

Modifications:
<pre>
- add a column named 'private' on to the LatePolicy model
- In the controller#index method, filter the results by private != 0 or instructor_id = current_user_id

</pre>

2. create and update have some duplicate code. Fix that using a partial, _form.

Filename: app/views/late_policies/new.html.erb

Current Code:
<pre>
<%= form_for @late_policy, :url => { :action => "create" } do |f| %>
<%= error_messages_for @late_policy %>


<label for="late_policy_name">Late policy name:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'policy_name' %>


<label for="late_policy_penalty_points_per_unit">Penalty points per unit:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'penalty_per_unit' %>


<label for="penalty_unit">Penalty unit:</label><label style="color: #ff0000;">*</label> 

<% @units= %w[Minute Hour Day]%>
<%= f.select "penalty_unit", @units %>


<label for="late_policy_penalty_maximum">Maximum penalty:</label><label style="color: #ff0000;">*</label> 
<%= f.text_field 'max_penalty' %>

</pre>

Modifications:
<pre>
<%= form_for @penalty_policy, :url => { :action => "create" } do |f| %>
<%= error_messages_for @penalty_policy %>
<%= render partial: 'form', locals: { f: f } %>
</pre>

3. Both create and update need comments and a better identifier naming.

Current identifiers names:
<pre>
* invalid_penalty_per_unit (Problem with this is ,try to read "!invalid_penalty_per_unit". So, "valid_penalty" increases the readability. )
* policy_name_exists
</pre>

Modifications:
<pre>
Got rid of both identifier names and implemented functions that validate input and check the duplicity of late policy name
* valid_penalty
* duplicate_name_check

</pre>

4. Reduce code duplication. Find a way to make the code more DRY

Extracted the validation done in both create and update into a seperate method. This reduced repition between the two methods. See part 5.

5. Line 64: The if condition can be simplified.

Origional Code:
<pre>
invalid_penalty_per_unit = params[:late_policy][:max_penalty].to_i < params[:late_policy][:penalty_per_unit].to_i
flash[:error] = 'The maximum penalty cannot be less than penalty per unit.' if invalid_penalty_per_unit
same_policy_name = false
# penalty name should be unique
if same_policy_name != LatePolicy.check_policy_with_same_name(params[:late_policy][:policy_name], instructor_id)
flash[:error] = 'A policy with the same name already exists.'
same_policy_name = true
end
# maximum penalty cannot be greater than equal to 100
if params[:late_policy][:max_penalty].to_i >= 100
flash[:error] = 'Maximum penalty cannot be greater than or equal to 100'
invalid_max_penalty = true
end

if !invalid_penalty_per_unit && !same_policy_name && !invalid_max_penalty
@late_policy = LatePolicy.new(late_policy_params)
@late_policy.instructor_id = instructor_id
begin
@late_policy.save!
flash[:notice] = 'The late policy was successfully created.'
redirect_to action: 'index'
rescue StandardError
flash[:error] = 'The following error occurred while saving the late policy: '
redirect_to action: 'new'
end
else
redirect_to action: 'new'
end
</pre>

Modifications:
<pre>
def validate_input(is_update=false)
# Validates input for create and update forms
max_penalty = params[:late_policy][:max_penalty].to_i
penalty_per_unit = params[:late_policy][:penalty_per_unit].to_i

valid_penalty, error_message = true, nil
valid_penalty, error_message = duplicate_name_check(is_update)
prefix = is_update ? "Cannot edit the policy. " : ""

#This check validates the maximum penalty.
if max_penalty < penalty_per_unit
error_message = prefix + 'The maximum penalty cannot be less than penalty per unit.'
valid_penalty = false
end

#This check validates the penalty per unit for a late policy.
if penalty_per_unit < 0
error_message = 'Penalty per unit cannot be negative.'
valid_penalty = false
end

# This checks maximum penalty does not exceed 100.
if max_penalty >= 100
error_message = prefix + 'Maximum penalty cannot be greater than or equal to 100'
valid_penalty = false
end

return valid_penalty, error_message
end

</pre>

6. Improve the variable name for same_policy_name. (Boolean variables can be named in a better way)

Current identifiers names:
<pre>
same_policy_name
</pre>

Modifications:
<pre>
Got rid of this identifier by replacing it with a function named "duplicate_name_check"
</pre>

7. Add method comments
<pre>
No comments
</pre>

Modifications:
<pre>
Added comments for all the methods to increase the readability of the code.
</pre>

==GitHub links==

Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/Wyatt-Plaga/expertiza-1 here]

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-21T22:02:46Z

Ssaleki: /* Files Involved */

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-21T21:59:36Z

Ssaleki:

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-21T21:58:23Z

Ssaleki:

CSC/ECE 517 Spring 2022 - E2216: Refactor late policies controller

2022-03-21T12:53:33Z

Ssaleki: /* Code Changes */