Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-11-17T23:03:43Z

Vvarada2: /* Design */

== Project Overview ==
=== Background ===
The Expertiza project takes advantage of peer review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resource is meaningful for instructors to study and improve the teaching experience, and also in evaluating the quality/sincerity of the reviews.

'''Previous work done in Fall 2019 enables tracking time between successive time tag assignment.''' 
[[File:Tagging1993.png|1000px]]

However, there are several problems with their solution:
* There is no automated tests using mocked data to test their implementation.
* The previous team added a tagging interval chart to each row (representing each participant) in the Answer Tagging report. However, the chart will be hard to read if there hundreds of tagging interval.

=== Objective ===
* Display the tagging interval information as a number alongside the graph in order to make it more intuitive to read
* Add test cases regarding new changes

'''Example Mockup of Added Column''' 
[[File:ECE517Project4 Mockup.png]]

=== Other possible changes to be made ===
* Refactor code from the previous implementation
* Display intervals using a different type of graph (bar graph, line graph, etc)
'''For loops that could be implemented into a separate method''' 
[[File:ECE517Project4 ForLoops.png]]

=== File Involved ===
* helpers/report_formatter_helper.rb
* helpers/review_mapping_helper.rb
* models/tag_prompt_deployment.rb
* models/vm_user_answer_tagging.rb
* views/reports/_answer_tagging_report.html.erb

=== Previous Work ===
The following links are the deliverables from the original implementation in Fall 2019.
 
* [http://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1993_Track_Time_Between_Successive_Tag_Assignments CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]
* [https://www.youtube.com/watch?v=YxR9sitpZcs&feature=youtu.be&ab_channel=HackOverFlow Youtube Explanation]
* [https://github.com/Galactis/expertiza Git Repository]
* [https://github.com/expertiza/expertiza/pull/1642 Git Pull Request]

=== Team ===
Joshua Aaron Horwitz (jahorwit)
 
Varun Varadarajan (vvarada2)
 
Nicholas Viado (ndviado)
 
Tsu-Hsin Yeh (tyeh3)
 
'''Mentor:''' Kai Xiao (yxiao28)

== Design ==

We propose a method that aims to perform:

1. Query the database for details on reviews and their tags

2. Update the existing chart logic to process these numbers

3. Update the report format to include these times

4. Add tests for internal logic and manual UI-testing too

HOW: We'll create an independent method for our logic and append it to the existing logic without necessarily modifying it

== Test Plan ==
To manually reproduce the scenario on the UI and test the results on our new/modified time reports

1. Manually impersonate the process of tagging reviews for a dummy assignment

2. Test that the tag times are recorded and displayed properly

3. Compare it with previous logic to check that values/logic is consistent

4. Regression test just to see that the existing charts aren't broken

=== Manual Testing ===
1. Logged in as Instructor 6 with username = instructor6 and password = password

2. Click "Manage..." -> "Assignments" from the top-left menu item

[[File:E2082_MT1.png|200px]]

3. Create a new assignment by clicking the + button

[[File:E2082_MT2.png|600px]]

4. Filling the necessary information in "General", "Rubrics", and "Due Dates" sections indicated in the following screenshots. Then click Create button.

[[File:E2082_MT3.png|600px]]

[[File:E2082_MT4.png|600px]]

[[File:E2082_MT5.png|600px]]

5. Edit Tagging Assignment and click add new.. under Tag prompt dropdown list

[[File:E2082_MT6.png|600px]]

6. Click the green + on the top-right of the popup window. Enter the value for prompt and desc as shown in the screenshot below. Click green + button at the right most column.

[[File:E2082_MT7.png|600px]]

7. Select Criterion for apply to question type. Click Save button.

[[File:E2082_MT8.png|600px]]

8. Click the Add Participants button, then add student7339 and student7430.

[[File:E2082_MT9.png|600px]]

9. Logged in as student7339 with password=password and make a submission from Your work

[[File:E2082_MT10.png|600px]]

10. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Submission to be two days before today.

[[File:E2082_MT11.png|400px]]

11. Logged in as student7430 with password=password and submit review from Others' work

[[File:E2082_MT12_5.png|600px]]
[[File:E2082_MT12.png|400px]]

12. Logged in as instructor6 and modify Tagging Assignment due date for Round 1: Review to be one day before today.
[[File:E2082_MT13.png|400px]]

13. Logged in as student7339 and tag the review from <Your scores>

[[File:E2082_MT14.png|600px]]

[[File:E2082_MT15.png|600px]]

14. Logged in as instructor6. Go to manage...->Assignment and click View Reports button.

[[File:E2082_MT16.png|600px]]

15. Select Answer Tagging Report and click View button.

[[File:E2082_MT17.png|600px]]

16. The highlighted column in blue rectangle is the new feature we added

=== Unit Tests ===

Tests were added to test the accuracy of calculating the statistics of the timings we have tracked in this project.
The comprehensive test can test all the math logic involved in our design.

[[File:Test_cases2.png]]

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

CSC/ECE 517 Fall 2020 - E2082. Track time between successive tag assignments

2020-10-23T00:44:48Z

Vvarada2: /* Background */

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T04:44:24Z

Vvarada2: /* How to Check */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move portion of the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:Approve_2.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve 1.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since only the code style/process was changed, the expected functionality before and after, will be the same. Student should be able to create a suggestion for an assignment, just like before.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|600px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|600px]]

*This will bring the following page (information previously provided by student_view.html.erb).

[[File:Student_view.png|600px]]

*The corresponding page for an instructor would appear as such.

[[File:Show_view.png|600px]]

'''Please refer to our short [[[https://drive.google.com/file/d/1YUyoIQT32WmiTSd_SZzLpWXSdqjkaiWz/view?usp=sharing video]]] to get more context on what was done'''

NOTE TO TA: Our Travis CI build failed because of an error in Travis's config settings (bundle exec danger --verbose). Hence, we have included this video as a proof of our working logic and testing.

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

This test ensures the working of the mailer method for approved suggestions

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T04:41:42Z

Vvarada2: /* How to Check */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move portion of the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:Approve_2.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve 1.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since only the code style/process was changed, the expected functionality before and after, will be the same. Student should be able to create a suggestion for an assignment, just like before.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|600px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|600px]]

*This will bring the following page (information previously provided by student_view.html.erb).

[[File:Student_view.png|600px]]

*The corresponding page for an instructor would appear as such.

[[File:Show_view.png|600px]]

'''Please refer to our short [[[https://drive.google.com/file/d/1YUyoIQT32WmiTSd_SZzLpWXSdqjkaiWz/view?usp=sharing video]]] to get more context on what was done'''
NOTE TO TA: Our Travis CI build failed because of an error in Travis's config settings (bundle exec danger --verbose). Hence, we have included this video as a proof of our working logic and tests.

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

This test ensures the working of the mailer method for approved suggestions

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T04:31:52Z

Vvarada2: /* Code Review */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move portion of the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:Approve_2.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve 1.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since only the code style/process was changed, the expected functionality before and after, will be the same. Student should be able to create a suggestion for an assignment, just like before.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|600px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|600px]]

*This will bring the following page (information previously provided by student_view.html.erb).

[[File:Student_view.png|600px]]

*The corresponding page for an instructor would appear as such.

[[File:Show_view.png|600px]]

'''Please refer to our short [[[https://drive.google.com/file/d/1YUyoIQT32WmiTSd_SZzLpWXSdqjkaiWz/view?usp=sharing video]]] to get more context on what was done'''

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

This test ensures the working of the mailer method for approved suggestions

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

File:Approve 2.png

2020-10-20T04:31:45Z

Vvarada2:

File:Approve 1.png

2020-10-20T04:29:22Z

Vvarada2:

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T03:05:56Z

Vvarada2: /* How to Check */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:SignUpTopic_approve_method_refactor.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve suggestion method refactor.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since only the code style/process was changed, the expected functionality before and after, will be the same. Student should be able to create a suggestion for an assignment, just like before.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|800px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|800px]]

*This will bring the following page that

8. Check that suggestion is shown after creation (like above picture)

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

This test ensures the working of the mailer method for approved suggestions

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T03:03:20Z

Vvarada2: /* Test Cases */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:SignUpTopic_approve_method_refactor.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve suggestion method refactor.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since this is a refactor project i.e. only the code was changed, the expected functionality before and after, represent the same functionality.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|800px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|800px]]

*This will bring the following page that

8. Check that suggestion is shown after creation (like above picture)

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

This test ensures the working of the mailer method for approved suggestions

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T03:03:07Z

Vvarada2: /* Test Cases */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:SignUpTopic_approve_method_refactor.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve suggestion method refactor.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since this is a refactor project i.e. only the code was changed, the expected functionality before and after, represent the same functionality.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|800px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|800px]]

*This will bring the following page that

8. Check that suggestion is shown after creation (like above picture)

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

These test ensures the working of the mailer method for approved suggestions

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

File:Snip4.PNG

2020-10-20T03:00:33Z

Vvarada2: Vvarada2 uploaded a new version of File:Snip4.PNG

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T02:59:02Z

Vvarada2: /* How to Check */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:SignUpTopic_approve_method_refactor.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve suggestion method refactor.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since this is a refactor project i.e. only the code was changed, the expected functionality before and after, represent the same functionality.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|800px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|800px]]

*This will bring the following page that

8. Check that suggestion is shown after creation (like above picture)

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

These test ensures the working of the mailer & approve_suggestion methods

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T02:58:19Z

Vvarada2: /* How to Check */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:SignUpTopic_approve_method_refactor.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve suggestion method refactor.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since this is a refactor project i.e. only the code was changed, the expected functionality before and after, represent the same functionality.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|800px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|800px]]

*This will bring the following page that

8. Student has an option to make a suggestion

9. Check that suggestion is shown after creation

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

These test ensures the working of the mailer & approve_suggestion methods

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

2020-10-20T02:57:10Z

Vvarada2: /* Code Review */

== Background ==

The '''suggestions_controller.rb''' of Expertiza is involved in creating/editing suggestions topic suggestions for a project and involved approvals. Students can submit suggestions and work on them if approved.

== Motivation ==
We intend to improve the readability and code quality of the suggestions_controller.rb. Since this controller has methods that must actually be done by other classes (owing to Single Responsibility feature of the SOLID principles), we have realized the need to move these methods to their respective classes.

== Issues to Fix ==
1. Move the method '''create_new_team''' (on line 94) to a more appropriate class.
(Ex: '''Team.rb''' or '''AssignmentTeam.rb''')

2. Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.

3. There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.

4. Move the '''send_email''' method to the '''Mailer''' class in '''app/mailers/mailer.rb'''.

5. In '''views/suggestion/show.html.erb''' and '''views/suggestion/student_view.html.erb''', there seems to be a DRY violation which needs to be fixed. Merge both files into a single view file in order to fix the DRY problem.

== Files Modified ==
*app/controllers/teams_controllers.rb
*app/models/sign_up_topic.rb
*app/mailers/mailer.rb
*views/suggestion/show.html.erb

== Code Review ==

'''''Issue''': Move the method '''create_new_team''' to a more appropriate class.''

This method was moved to '''assignment_team.rb''' since it is appropriate.

[[File:Snip2.PNG]]

We pass the required variables inside the scope of this function as method parameters.
Then we call the new method as a method of the '''AssignmentTeam''' class.

[[File:Snip3.PNG]]

'''''Issue''': Move the method '''approve''' to '''SignupTopic.rb''', since it is modifying fields belonging to '''SignupTopic''' directly.''

[[File:SignUpTopic_approve_method_refactor.png]]

First, we moved everything in the approve method from '''suggestion_controller''' having to do with a sign up topic to its own new method in '''sign_up_topic.rb''' now called '''new_topic_from_suggestion'''. In doing so, we also delete the entire '''approve method''' from '''suggestion_controller''', since refactoring for that method happens concurrently as a result of another issue in this project.

'''''Issue''':There are two methods named similarly: '''approve''' and '''approve_suggestion'''. Their functionality is not clear at first glance. Rename them so that they more accurately reflect their purpose. Add appropriate comments.''

[[File:Approve suggestion method refactor.png]]

Here, we changed the name of '''approve_suggestion''' to '''approve_suggestion_and_notify''', since it really seems like this method is both to handle approving a suggestion as well as calling the notification method from elsewhere in the controller class. We also add in the first part of the original "approve" method here, so that we can set the instance variables that suggestion_controller might need ('''@user_id, @team_id, and @topic_id''') as well as calling our newly created '''new_topic_from_suggestion''' method in '''SignUpTopic''' with the proper suggestion passed as a parameter.

'''''Issue''': Move the '''send_email''' method to the '''Mailer''' class.''

This method was moved to the '''Mailer.rb''' file which seems to have many built-in functionalities for mail services.

[[File:Snip1.PNG]]

Next, the required variables for this method were passed as parameters from '''suggestion_controller''' and is called as a method of Mailer class

[[File:Snip4.PNG]]

'''''Issue''': Merge '''app/views/suggestion/show.html.erb''' and '''app/views/suggestion/student_view.html.erb''' into one view.

Modify student_view method in suggestion controller to provide '''@current_role_name''' and '''render show''' template.

[[File:modified show student.png]]

Migrate code from '''student_view.html.erb''' to '''show.html.erb''' and wrap in an if statement that will display view only if user role is a student.

[[File:Student_View.png|1200px]]

Move the rest of the remaining code from the original show template to the else block.

[[File:Show_View.png|1200px]]

Delete the '''student_view.html.erb''' file since all of it's contents are contained within the '''show.html.erb''' file.

[[File:Deleted Student_View.png|1200px]]

== How to Check ==

Since this is a refactor project i.e. only the code was changed, the expected functionality before and after, represent the same functionality.

1. Log in as an instructor.

*Login with username '''instructor6''' and password '''password'''.

[[File:Login.jpg|1200px]]

2. Create a new assignment.

*Click the '''Assignments''' link.

[[File:Click_assignments.png|1200px]]

*Click the '''+''' icon.

[[File:Click_plus_icon.png|1200px]]

3. Fill in the following fields in the ''''General'''' tab.

*Provide '''Assignment name'''.
*Check the '''Has Teams''' checkbox and set maximum number of members to greater than or equal to 1.
*Click the '''Create''' button.

[[File:General_tab.png]]

*Page will reload and have an additional checkbox, '''Has topics?'''. Check it off and click the '''Save''' button.

[[File:Has_topics.png]]

4. Make the following selections in the '''Topics''' tab.

[[File:Topics_tab.png|600px]]

5. Assign this assignment to a student belonging to this instructor

*Select '''Add participant''' link within the '''Other stuff''' tab. This will bring you to a new page.

[[File:Other_stuff.png|1000px]]

*Find student of interest (we recommend using '''student1876'''). Select '''Add''' button.

[[File:Find_student.png|1200px]]

*You should receive confirmation of successfully adding the student to the assignment.

[[File:Add_student_confirmation.png|800px]]

6. Impersonate the assigned student.

*Select from the Manage dropdown menu '''Impersonate User'''.

[[File:Impersonate_student.png|1200px]]

*Fill in field with student username and select '''Impersonate''' button.

[[File:Impersonate_student_fill_in.png|800px]]

7. Let the student view this assignment (may need to register too)

*Select the created assignment from the table seen at the bottom of the page.

[[File:Select_new_assignment.png|1200px]]

*Select '''Suggest a topic''' link.

[[File:Suggest_topic.png|800px]]

*Create new suggestion, provide a title, description, and click the '''Submit''' button.

[[File:Student_suggestion.png|800px]]

*Select '''View''' link for the suggestion created.

[[File:View student_suggestion.png|800px]]

*This will bring the following page that

8. Student has an option to make a suggestion

10. Check that suggestion is shown after creation

== Test Cases ==

The demonstration shown in the above section is how we tested the functionality and behavior of our changes.
The spec tests below will test that the moved methods work independently.

These test ensures the working of the mailer & approve_suggestion methods

[[File:Mailer test.png]]

This test ensures the working of the team creation method

[[File:spec2.png]]

== References ==
*[http://152.7.99.171:8080/ Our Deployed Expertiza]
*[https://github.com/GitHubSanti/expertiza/tree/beta Expertiza on GitHub]

== Team Members ==
*Varun Varadarajan (vvarada2)
*Dylan Jordan (dtjordan)
*Santiago Sepulveda (sasepulv)
*'''Mentor:''' Sanket Pai (sgpai2)

CSC/ECE 517 Fall 2020 - E2069. refactor suggestions controller

File:Snip4.PNG

2020-10-20T02:37:06Z

Vvarada2:

File:Snip3.PNG

2020-10-20T02:36:35Z

Vvarada2: Vvarada2 uploaded a new version of File:Snip3.PNG

File:Snip3.PNG

2020-10-20T02:35:58Z

Vvarada2:

File:Snip2.PNG

2020-10-20T02:35:37Z

Vvarada2: Vvarada2 uploaded a new version of File:Snip2.PNG