Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-06T00:06:26Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* '''Is_intelligent (Swetha)'''

---------------------------------------------------
* '''Participants variable'''
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* '''Staggered Deadlines of Topics in Assignment'''

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* '''Add_signup_topics'''

Previously we encountered an error page when attempting to create a topic with the same name as an existing topic. The functionality was set up to update the attributes of the existing topic and then redirect the user to add_signup_topics. However this route was broken ( from an error in a different controller class) and the functionality was very unclear from reading the code.

We have changed this so that when the user attempts to create a new topic with the same name as an existing topic, the topic attributes are updated as before, but the user is instead redirected back to the topics tab of the assignment edit page.

Old ( in def update_existing_topic )
topic.update_attributes(topic_params)
redirect_to_sign_up(params[:id])
New:
topic.update_attributes(topic_params)
redirect_to edit_assignment_path(params[:id], anchor: 'tabs-2')

With this change we were also able to remove the below method:

def redirect_to_sign_up(assignment_id)
assignment = Assignment.find(assignment_id)
assignment.staggered_deadline == true ? (redirect_to action: 'add_signup_topics_staggered', id: assignment_id) :
(redirect_to action: 'add_signup_topics', id: assignment_id)
end

We also updated the corresponding rspec tests to reflect the change:

old:
expect(response).to redirect_to('/signup_sheet/add_signup_topics?id=1')
new:
expect(response).to redirect_to('/assignments/1/edit#tabs-2')

commits:

https://github.com/weichic-ncsu/expertiza/commit/5dec776b7355290efde7e2249de83d89fd0dd259

https://github.com/weichic-ncsu/expertiza/commit/8ab175b02cf825f5f414e04e33f1790da0f1bd93

https://github.com/weichic-ncsu/expertiza/commit/1dcd1b8107657fbeaaea60a586e6705dc0cf3404
---------------------------------------------------

* '''Methods removed (Swetha)'''
---------------------------------------------------

* '''Methods moved (Swetha)'''

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-06T00:05:23Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* '''Is_intelligent (Swetha)'''

---------------------------------------------------
* '''Participants variable'''
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* '''Staggered Deadlines of Topics in Assignment'''

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* '''Add_signup_topics'''

Previously we encountered an error page when attempting to create a topic with the same name as an existing topic. The functionality was set up to update the attributes of the existing topic and then redirect the user to add_signup_topics. However this route was broken ( from an error in a different controller class) and the functionality was very unclear from reading the code.

We have changed this so that when the user attempts to create a new topic with the same name as an existing topic, the topic attributes are updated as before, but the user is instead redirected back to the topics tab of the assignment edit page.

Old ( in def update_existing_topic )
topic.update_attributes(topic_params)
redirect_to_sign_up(params[:id])
New:
topic.update_attributes(topic_params)
redirect_to edit_assignment_path(params[:id], anchor: 'tabs-2')

With this change we were also able to remove the below method:

def redirect_to_sign_up(assignment_id)
assignment = Assignment.find(assignment_id)
assignment.staggered_deadline == true ? (redirect_to action: 'add_signup_topics_staggered', id: assignment_id) :
(redirect_to action: 'add_signup_topics', id: assignment_id)
end

We also updated the corresponding rspec tests to reflect the change:

old:
expect(response).to redirect_to('/signup_sheet/add_signup_topics?id=1')
new:
expect(response).to redirect_to('/assignments/1/edit#tabs-2')

commits:
https://github.com/weichic-ncsu/expertiza/commit/5dec776b7355290efde7e2249de83d89fd0dd259
https://github.com/weichic-ncsu/expertiza/commit/8ab175b02cf825f5f414e04e33f1790da0f1bd93
https://github.com/weichic-ncsu/expertiza/commit/1dcd1b8107657fbeaaea60a586e6705dc0cf3404
---------------------------------------------------

* '''Methods removed (Swetha)'''
---------------------------------------------------

* '''Methods moved (Swetha)'''

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-06T00:04:59Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* '''Is_intelligent (Swetha)'''

---------------------------------------------------
* '''Participants variable'''
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* '''Staggered Deadlines of Topics in Assignment'''

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* '''Add_signup_topics'''

Previously we encountered an error page when attempting to create a topic with the same name as an existing topic. The functionality was set up to update the attributes of the existing topic and then redirect the user to add_signup_topics. However this route was broken ( from an error in a different controller class) and the functionality was very unclear from reading the code.

We have changed this so that when the user attempts to create a new topic with the same name as an existing topic, the topic attributes are updated as before, but the user is instead redirected back to the topics tab of the assignment edit page.

Old ( in def update_existing_topic )
topic.update_attributes(topic_params)
redirect_to_sign_up(params[:id])
New:
topic.update_attributes(topic_params)
redirect_to edit_assignment_path(params[:id], anchor: 'tabs-2')

With this change we were also able to remove the below method:

def redirect_to_sign_up(assignment_id)
assignment = Assignment.find(assignment_id)
assignment.staggered_deadline == true ? (redirect_to action: 'add_signup_topics_staggered', id: assignment_id) :
(redirect_to action: 'add_signup_topics', id: assignment_id)
end

We also updated the corresponding rspec tests to reflect the change:

old:
expect(response).to redirect_to('/signup_sheet/add_signup_topics?id=1')

new:
expect(response).to redirect_to('/assignments/1/edit#tabs-2')

commits:
https://github.com/weichic-ncsu/expertiza/commit/5dec776b7355290efde7e2249de83d89fd0dd259
https://github.com/weichic-ncsu/expertiza/commit/8ab175b02cf825f5f414e04e33f1790da0f1bd93
https://github.com/weichic-ncsu/expertiza/commit/1dcd1b8107657fbeaaea60a586e6705dc0cf3404
---------------------------------------------------

* '''Methods removed (Swetha)'''
---------------------------------------------------

* '''Methods moved (Swetha)'''

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-06T00:03:43Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* '''Is_intelligent (Swetha)'''

---------------------------------------------------
* '''Participants variable'''
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* '''Staggered Deadlines of Topics in Assignment'''

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* '''Add_signup_topics (Juan)'''

Previously we encountered an error page when attempting to create a topic with the same name as an existing topic. The functionality was set up to update the attributes of the existing topic and then redirect the user to add_signup_topics. However this route was broken ( from an error in a different controller class) and the functionality was very unclear from reading the code.

We have changed this so that when the user attempts to create a new topic with the same name as an existing topic, the topic attributes are updated as before, but the user is instead redirected back to the topics tab of the assignment edit page.

Old ( in def update_existing_topic )
topic.update_attributes(topic_params)
redirect_to_sign_up(params[:id])
New:
topic.update_attributes(topic_params)
redirect_to edit_assignment_path(params[:id], anchor: 'tabs-2')

With this change we were also able to remove the below method:

def redirect_to_sign_up(assignment_id)
assignment = Assignment.find(assignment_id)
assignment.staggered_deadline == true ? (redirect_to action: 'add_signup_topics_staggered', id: assignment_id) :
(redirect_to action: 'add_signup_topics', id: assignment_id)
end

We also updated the corresponding rspec tests to reflect the change:

old:
expect(response).to redirect_to('/signup_sheet/add_signup_topics?id=1')

new:
expect(response).to redirect_to('/assignments/1/edit#tabs-2')
---------------------------------------------------

* '''Methods removed (Swetha)'''
---------------------------------------------------

* '''Methods moved (Swetha)'''

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-06T00:00:52Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* '''Is_intelligent (Swetha)'''

---------------------------------------------------
* '''Participants variable'''
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* '''Staggered Deadlines of Topics in Assignment'''

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* '''Add_signup_topics (Juan)'''

Previously we encountered an error page when attempting to create a topic with the same name as an existing topic. The functionality was set up to update the attributes of the existing topic and then redirect the user to add_signup_topics. However this route was broken ( from an error in a different controller class) and the functionality was very unclear from reading the code.

We have changed this so that when the user attempts to create a new topic with the same name as an existing topic, the topic attributes are updated as before, but the user is instead redirected back to the topics tab of the assignment edit page.

Old :
topic.update_attributes(topic_params)
redirect_to_sign_up(params[:id])
New:
topic.update_attributes(topic_params)
redirect_to edit_assignment_path(params[:id], anchor: 'tabs-2')

With this change we were also able to remove the below method:

def redirect_to_sign_up(assignment_id)
assignment = Assignment.find(assignment_id)
assignment.staggered_deadline == true ? (redirect_to action: 'add_signup_topics_staggered', id: assignment_id) :
(redirect_to action: 'add_signup_topics', id: assignment_id)
end

and updated the corresponding rspec tests to reflect the change:

old:

new:
---------------------------------------------------

* '''Methods removed (Swetha)'''
---------------------------------------------------

* '''Methods moved (Swetha)'''

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:59:11Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* '''Is_intelligent (Swetha)'''

---------------------------------------------------
* '''Participants variable'''
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* '''Staggered Deadlines of Topics in Assignment'''

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* '''Add_signup_topics (Juan)'''

Previously we encountered an error page when attempting to create a topic with the same name as an existing topic. The functionality was set up to update the attributes of the existing topic and then redirect the user to add_signup_topics. However this route was broken ( from an error in a different controller class) and the functionality was very unclear from reading the code.

We have changed this so that when the user attempts to create a new topic with the same name as an existing topic, the topic attributes are updated as before, but the user is instead redirected back to the topics tab of the assignment edit page.

With this change we were able to remove the below method:

def redirect_to_sign_up(assignment_id)
assignment = Assignment.find(assignment_id)
assignment.staggered_deadline == true ? (redirect_to action: 'add_signup_topics_staggered', id: assignment_id) :
(redirect_to action: 'add_signup_topics', id: assignment_id)
end
---------------------------------------------------

* '''Methods removed (Swetha)'''
---------------------------------------------------

* '''Methods moved (Swetha)'''

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:54:49Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* '''Is_intelligent (Swetha)'''

---------------------------------------------------
* '''Participants variable'''
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* '''Staggered Deadlines of Topics in Assignment'''

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* '''Add_signup_topics (Juan)'''
---------------------------------------------------

* '''Methods removed (Swetha)'''
---------------------------------------------------

* '''Methods moved (Swetha)'''

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:53:25Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* Is_intelligent (Swetha)

---------------------------------------------------
* Participants variable
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4
---------------------------------------------------

* Staggered Deadlines of Topics in Assignment

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video
---------------------------------------------------

* Add_signup_topics (Juan)
---------------------------------------------------

* Methods removed (Swetha)
---------------------------------------------------

* Methods moved (Swetha)

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:53:02Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* Is_intelligent (Swetha)

---------------------------------------------------
* Participants variable
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4

* Staggered Deadlines of Topics in Assignment

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video

* Add_signup_topics (Juan)

* Methods removed (Swetha)

* Methods moved (Swetha)

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:52:41Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* Is_intelligent (Swetha)

* Participants variable (Juan)
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

Commit : https://github.com/weichic-ncsu/expertiza/commit/7b8a230f8d0ddb3953ec3a9db8506caa2bb691e4

* Staggered Deadlines of Topics in Assignment

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video

* Add_signup_topics (Juan)

* Methods removed (Swetha)

* Methods moved (Swetha)

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:51:45Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* Is_intelligent (Swetha)

* Participants variable (Juan)
References to participants (plural) have been replaced with @team_members for clarity, consistency as team_members was used in a similar fashion elsewhere in the controller and to avoid clashing with @participant (singular), which is used in many areas.

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

* Staggered Deadlines of Topics in Assignment

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video

* Add_signup_topics (Juan)

* Methods removed (Swetha)

* Methods moved (Swetha)

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:50:47Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* Is_intelligent (Swetha)

* Participants variable (Juan)
References to participants (plural) have been replaced with @team_members for clarity

Example Old:
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
Example New:
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

* Staggered Deadlines of Topics in Assignment

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video

* Add_signup_topics (Juan)

* Methods removed (Swetha)

* Methods moved (Swetha)

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T23:49:30Z

Jdbenavi: /* Code Modifications ( Work Completed) */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* Is_intelligent (Swetha)

* Participants variable (Juan)
<% @participants = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>
<% @team_members = SignedUpTeam.find_team_participants(@assignment.id, session[:ip]) %>

* Staggered Deadlines of Topics in Assignment

:* Added back views rendered for staggered deadlines in the signup sheet

:* Fixed controller error of this feature

:* Tested this feature with demo video

* Add_signup_topics (Juan)

* Methods removed (Swetha)

* Methods moved (Swetha)

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-12-05T22:12:00Z

Jdbenavi: /* Code Modifications */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This attribute is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the attribute.

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb

* The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller. It is also indicative of poor class design and violation of the Single Responsibility Principle.

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to create/delete new topics for an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Remove violations of Single Responsibility principle by refactoring the design of the controller.

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Plan of Work==

* '''Controller Re-design'''

The signup_sheet controller currently has 30 methods, which is a violation of the upper limit for methods in a controller.Upon analysis, we found that signup_sheet controller has methods related to creating/updating and deleting topics as well as methods to create and delete a sign-up for those topics in an assignment. This is certainly a violation of the Single Responsibility principle as this controller handles responsibilties of both topic CRUD and signup CRUD operations. To fix this, we have proposed to split this controller and create a new controller for Topics to manage its responsibilities. We plan to split up the methods as per below Class Diagram -

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

The new design follows '''Single Responsibility''', and the methods were split up on the basis of '''Information Expert''' pattern. Using the principle of Information Expert, a general approach to assigning responsibilities is to look at a given responsibility, determine the information needed to fulfill it, and then determine where that information is stored.

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec. Further, new tests will have to added/ old tests will have to be repurposed to check the newly designed Topic controller.

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper modules:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

; Verify setting up staggered deadlines of signup topics in assignments
# Login as instructor
# Hover on "Manage" Tab
# Click on "Assignments" Tab
# Click on Edit Button for "Wikipedia contribution" assignment
# Select "Staggered deadline assignnment?" checkbox
# Click "OK" at the popping up dialog
# Click "Save" button
# Click on "Topics" Tab
# Scroll down to the bottom and click "Show start/due date"
# Find out 2 topics, which are selected by at least 1 student, respectively
# Setup different deadlines for them and make sure one topic is in submission stage and the other one is in review stage
# Click "Save" button
# The updates should be saved without any error
# Sign in as one of the students for each topic, you should see different stages of the assignment "Wikipedia contribution" in the assignment list

== Code Modifications ( Work Completed) ==

* Is_intelligent (Swetha)

* Participants variable (Juan)

* Staggered ( Wei-Chi)

* Add_signup_topics (Juan)

* Methods removed (Swetha)

* Methods moved (Swetha)

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T23:05:29Z

Jdbenavi: /* Controller Re-design */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
*Provide extensive comments for all the code you view/refactor/modify.
*Ensure that any code changes do not break any functionality. Refactoring method names might cause cascaded updates in other files.

*Address and test effects of add_signup_topics_staggered
:* Add_signup_topics_staggered was supposed to make sure that the deadlines are set. [Assignment 1042 has staggered deadlines]. However, it was removed in the last version since it did not do anything different from add_signup_topics.
:* Currently in RSpec, it is only implicitly tested in the method create.

*Refactor participants variable in load_add_signup_topics
:* [In retrospect, the meaning of this is not clear. The @participants variable is used in a way that is very obscure, with code spread across several views, and no comments saying what it is doing. It used to be that participants (individual students) signed up for topics. Now, only teams can sign up for topics. So @participants does not make sense.] [Has this been fixed?]

*There are nine checks for @assignment.is_intelligent. This method is atrociously named. It simply checks for whether bidding is being used to assign topics.
:* Rename the method. ( not a method?)
:* Figure out some way to remove all or almost all of those checks, which are a gross violation of the Single-Responsibility Principle (as well as cohesion).

*Also see Code Climate issues. To reduce the size of the file, you could move some methods to sign_up_sheet_helper.rb [Has this been done?.]

*New topics controller to handle methods related to Topics. *TODO expand on this*

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]

: We ( @sswetha08 @weichic-ncsu @juanbenavid ) have performed the following refactoring to fix the issues specified for this refactoring project:

:* Renamed "sign_up" to be "signup" when it is used as adjective or noun for variable/method/controller name.

:* Update method refactored by removing explicit update of every attribute of topic and instead performing this task through update_attributes function provided by rails. Further, update_max_choosers method changed to update_waitlist to support this.

:* Removed add_signup_topics_staggered() and replaced it with add_signup_topics() since it does nothing but call add_signup_topics().

:* Removed load_add_signup_topics() since it does nothing for add_signup_topics().

:* Removed the feature to sign up for a topic as an instructor as there seems to be no way to access this feature from the views.

:* List method was too long and has been refactored.

: We have also added two new test cases for the controller:

:* Destroy signup_sheet when there are other topics in the assignment
:* General test case added for rendering list view

* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]
:* DRYed out code used to check for certain errors; however, that was done using an array of messages and then selecting one of them using a constant subscript, whereas it would have been better to pass the messages as parameters.
:* The compute_signup_topics method returns results by side-effects (in instance variables); probably this could have been done more cleanly.
:* Most of the changes involve regularizing use of "sign_up" vs. "signup"; this should ideally be done in a separate commit so it would be mergeable without merging the whole project.

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to add/remove topics to an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

* Magic Tricks of Testing
:* Test incoming command messages by making assertions about direct public side effects.

* Increase Cohesion and Minimize Coupling

* DRY out the code wherever possible

* Improve code clarity by naming methods and variables appropriately

* Improve code clarity of the controller by moving non-CRUD methods to helper functions wherever applicable

==Controller Re-design==

We are proposing to add a new topics controller to handle some of the current methods, as in the following diagram:

[[File:SUPCLASS.PNG|300px|Image: 300 pixels]]

[[File:SUPCLASSNEW.PNG|500px|Image: 500 pixels]]

This design adheres to single responsibility and information expert

==Plan of Work==

* '''@Participants variable'''

References to @participants is scattered throughout the project, including some references in signup sheet views. This variable was removed in the signup sheet controller in the previous pull request for the Fall 2022 OSS project, but references in views have not been removed. In the OSS project we noticed that test coverage for some of the methods/views in this controller were incomplete, so we should make sure the removal of this variable does not cause problems. The naming could also use improvement, as only teams are allowed to signup for projects.

[[File:participantsVar.png]]

There is also naming confusion because the controller has many references to the (singular) participant variable, and it is not clear how the two are supposed to be different. So better comments/naming is important.

def delete_signup
participant = AssignmentParticipant.find(params[:id])
...
...
def list
@participant = AssignmentParticipant.find(params[:id].to_i)
@assignment = @participant.assignment
...

* '''New Topics Controller'''
In order to clean up the controller, we plan to move many of the methods to a new topic controller ( see above diagram)

* '''Increase Test Coverage'''
We noticed that in general the controller could use more/better rspec tests as some error pages we encountered while manually testing were not captured by the current rspec

*''' Address and test effects of add_signup_topics_staggered '''
:* Work done
::* RSpec
:::* When creating a topic which could be found, test the availability in different values of assignment.staggered_deadline.

context 'when topic can be found' do
context 'when assignment.staggered_deadline is True' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
context 'when assignment.staggered_deadline is False' do
it 'updates the existing topic and redirects to signup_sheet#add_signup_topics page' do
...
end
end
end

:* Plan
::* RSpec
:::* Test add_signup_topics explicitly with different assignments as the input argument.
::* Mandatory
:::* Test the route from app/views/assignments/edit/_topics.html.erb with different assignment_form.

* '''Assignment is_intelligent attribute is a source of confusion'''

There are several checks for @assignment.is_intelligent across the controllers and views. This attribute is atrociously named. It
simply checks for whether bidding is being used to assign topics.

Proposed changes include renaming the attribute to bid_for_topics which more accurately captures its purpose.
If this attribute were to be renamed, it would involve a lot of changes across the project -

:* The schema for Assignment would have to be updated
t.boolean "is_intelligent"
:* All creation of Assignment objects across the code and specs would have to be changed

context 'when current assignment is not intelligent assignment' do
it 'renders signup_sheet#list page' do
assignment.is_intelligent = false
allow(Bid).to receive(:where).with(team_id: 1).and_return([double('Bid', topic_id: 1)])
request_params = { id: 1 }
get :list, params: request_params
expect(response).to render_template(:list)
end
end
:* Existing test or sample DB data for Assignments would also have to be updated accordingly.

:* Views including tree_display would also be affected as they contain checks like this -

(props) =>
props.is_intelligent
? {
title: 'Intelligent Assignment',
href: '/lottery/run_intelligent_assignment/' + `${parseInt(props.id) / 2}`,
src: '/assets/tree_view/run-lottery.png'
}

Further changes include reducing these number of checks to reduce coupling with other modules.

* ''' Code Climate Issues '''
https://codeclimate.com/github/expertiza/expertiza/app/controllers/sign_up_sheet_controller.rb#

Some issues observed on Code Climate for this controller -
:* Class SignUpSheetController has 32 methods (exceeds 20 allowed).
:* Class has too many lines. [393/100]

We plan to move some methods that are not directly involves in CRUD to the helper module:
update_waitlist
compute_signed_up_topics
add_signup_topics,
set_values_for_new_topic,
set_priority,
switch_original_topic_to_approved_suggested_topic

== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
:* rspec spec/controllers/signup_sheet_controller_spec.rb
: We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
:* rspec spec/helpers/signup_sheet_helper_spec.rb
:* rspec spec/models/signup_sheet_spec.rb

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

*New Tests

== Code Modifications==

==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:59:51Z

Jdbenavi: /* Controller Re-design */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:58:57Z

Jdbenavi: /* Controller Re-design */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:58:43Z

Jdbenavi: /* Controller Re-design */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:57:33Z

Jdbenavi: /* Controller Re-design */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:57:05Z

Jdbenavi: /* Plan of Work */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:56:10Z

Jdbenavi: /* Controller Re-design */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:54:59Z

Jdbenavi:

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:53:41Z

Jdbenavi:

File:SUPCLASS.PNG

2022-11-20T22:51:56Z

Jdbenavi:

File:SUPCLASSNEW.PNG

2022-11-20T22:51:39Z

Jdbenavi:

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-20T22:09:33Z

Jdbenavi:

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-16T00:03:28Z

Jdbenavi: /* Test Plan */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T14:07:56Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T14:07:26Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T14:05:01Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T14:04:32Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:45:24Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:44:06Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:43:06Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:42:44Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:40:14Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:40:04Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:38:26Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-15T13:37:57Z

Jdbenavi: /* Plan and List of Work done (specific tasks planned) */

File:ParticipantsVar.png

2022-11-15T13:32:39Z

Jdbenavi:

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:26:48Z

Jdbenavi: /* Prior Work section with last years and last projects background */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:26:32Z

Jdbenavi: /* CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:26:16Z

Jdbenavi: /* Prior Work section with last years and last projects background */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:25:48Z

Jdbenavi: /* Prior Work section with last years and last projects background */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:23:44Z

Jdbenavi: /* Problem Statement */

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:20:45Z

Jdbenavi: /* Problem Statement */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
* describe the issues?

==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]
* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to add/remove topics to an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

==Plan and List of Work done (specific tasks planned)==
* assignment is intelligent? (Swetha)
* participants variable (Juan)
* topics staggered ( Wei-Chi)
== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
: rspec spec/controllers/signup_sheet_controller_spec.rb
We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
: rspec spec/helpers/signup_sheet_helper_spec.rb
: rspec spec/models/signup_sheet_spec.rb

; New test cases
: Destroy signup_sheet when there are other topics in the assignment
: New, more general test case added for rendering list view, as we noticed that some functionalities we broke while refactoring did not result in failed test cases.

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

*New Tests

==Modifications (probably after working on them)==
==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:20:15Z

Jdbenavi: /* Prior Work section with last years and last projects background */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
==Prior Work section with last years and last projects background==
* [[CSC/ECE 517 Fall 2022 - E2259. Refactor signup_sheet_controller]]
* [[CSC/ECE 517 Spring 2022 - E2223. Refactor sign up sheet controller.rb]]

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to add/remove topics to an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

==Plan and List of Work done (specific tasks planned)==
* assignment is intelligent? (Swetha)
* participants variable (Juan)
* topics staggered ( Wei-Chi)
== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
: rspec spec/controllers/signup_sheet_controller_spec.rb
We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
: rspec spec/helpers/signup_sheet_helper_spec.rb
: rspec spec/models/signup_sheet_spec.rb

; New test cases
: Destroy signup_sheet when there are other topics in the assignment
: New, more general test case added for rendering list view, as we noticed that some functionalities we broke while refactoring did not result in failed test cases.

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

*New Tests

==Modifications (probably after working on them)==
==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:18:31Z

Jdbenavi: /* Test Plan */

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
==Prior Work section with last years and last projects background==

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to add/remove topics to an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

==Plan and List of Work done (specific tasks planned)==
* assignment is intelligent? (Swetha)
* participants variable (Juan)
* topics staggered ( Wei-Chi)
== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
: rspec spec/controllers/signup_sheet_controller_spec.rb
We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
: rspec spec/helpers/signup_sheet_helper_spec.rb
: rspec spec/models/signup_sheet_spec.rb

; New test cases
: Destroy signup_sheet when there are other topics in the assignment
: New, more general test case added for rendering list view, as we noticed that some functionalities we broke while refactoring did not result in failed test cases.

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

*New Tests

==Modifications (probably after working on them)==
==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:17:48Z

Jdbenavi:

== Team ==
=== Mentor ===
* Ed Gehringer (efg)

=== Team Members ===
* Juan Benavides (jdbenavi)
* Wei-Chi Chen (wchen37)
* Swetha Sairamakrishnan (ssairam)

==Problem Statement==
==Prior Work section with last years and last projects background==

== About Controller ==
The sign up sheet controller performs the following functions:
* Allows an instructor to add/remove topics to an assignment.
* Allows an instructor to assign/remove students to topics (This has been removed as it is unused/impersonation of student is used instead)
* Allows a student to see the list of available topics which can be bid on for given OSS assignment.

== General Design Goals ==

==Plan and List of Work done (specific tasks planned)==
* assignment is intelligent? (Swetha)
* participants variable (Juan)
* topics staggered ( Wei-Chi)
== Test Plan ==
=== Edge Cases and Pre-Conditions ===
# When dropping topic if submission already done.
# When deadline from dropping topic has passed.
# Deleting topic when topic cannot be found.
# Signup in case when user cannot be found.
# Create signup_sheet when sign_up_topic cannot be found.
# Destroy signup_sheet when other topics with the same assignment exists.
:

=== RSpec ===
: As such no functionality changed in any function, only refactoring done. All the refactoring was carefully verified by running rspec tests. To run the spec file, run:
: rspec spec/controllers/signup_sheet_controller_spec.rb
We also ran the rspecs for signup_sheet model and helper just to make sure no functionality was broken.
: rspec spec/helpers/signup_sheet_helper_spec.rb
: rspec spec/models/signup_sheet_spec.rb

; New test cases
: Destroy signup_sheet when there are other topics in the assignment
: New, more general test case added for rendering list view, as we noticed that some functionalities we broke while refactoring did not result in failed test cases.

[[File:F22_Signup_rspec.png]]

=== Mandatory ===
; Login as instructor
# Hover on Manage Tab
# Click on Assignments Tab
# Click on Edit Button for "OSS project & documentation" assignment
# Select the Topic Tab
# Add New Topic or Delete topic using links in the form below

; Login as student
# Click on OSS project/Writing assignment 2
# Click on Signup sheet
# The list must be visible, which indicates functionality is as before after refactoring list function.

*Testing Scenarios (Basic + Edge cases)
*RSpec Testing
*Manual Testing
*New Tests

==Modifications (probably after working on them)==
==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
* We have deployed the project at http://152.7.99.122:8080/
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5899, password -> password

CSC/ECE 517 Fall 2022 - E2279. Further refactoring and improvement of signup sheet controller

2022-11-14T23:15:11Z

Jdbenavi: /* General Design Goals = */

*Team
*Members
*Mentor
==Problem Statement==
==Prior Work section with last years and last projects background==
== General Design Goals ==

==Plan and List of Work done (specific tasks planned)==
* assignment is intelligent? (Swetha)
* participants variable (Juan)
* topics staggered ( Wei-Chi)

==Test Plan==
*Testing Scenarios (Basic + Edge cases)
*RSpec Testing
*Manual Testing
*New Tests

==Modifications (probably after working on them)==
==Relevant Links==
*https://github.com/weichic-ncsu/expertiza
*Link to Pull Request
*http://152.7.99.122:8080/