Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-18T20:13:04Z

Dpatel14: /* Snapshots */

==Problem Statement==

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

==Pre-Conditions==

These are the pre-conditions that needs to hold true for each functionality to work

:· The maximum number of students that can be assigned to the project cannot be more than 1.
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
:· Students can nominate for badges without providing a justification only if the instructor has not kept the justification field mandatory.

==Implementation Steps==

:· Provide professors an option to add all possible badges to a project.
:· Also provide the professor an option to make the justification field mandatory or not.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.

==Modifications To Be Done==

*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_badges_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page

*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
id: primary key
name: varchar
description: varchar

:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
Id: Primary key
assignment_id: foreign key
questionnaire_id: foreign key
badge_id: foreign key

==Execution Flow==
[[File:Oodd5.PNG]]

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

==Design==
[[File:Oodd2.PNG]]

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

==Snapshots==

Note: Currently the images contain dummy data because the data will be available from the project [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2_Lightweight_Badging_System E17A2]

Below are the changes which are planned:

:·Added a new icon to the assignments which will redirect to a summary of the nominations for the assignment
[[File:Summary_Icon.PNG]]
:·The new view for the instructor where the instructor can see the list of nominations for the assignment (This will be in the path /assignments/:id/nominations)
[[File:New_View_For_Instructor.PNG]]
:·The instructor can decide whether to keep the justification mandatory or not. This will be added under the review strategy tab.
[[File:Instructor_Review_Strategy.jpg]]
:·The instructor can decide which badges to be allowed for nomination for the assignment from the list of all the available badges. Multiple selection is possible. This has been added as a new tab called "Available Badges for Nominations"
[[File:Nominations_Tab.PNG]]

[[File:Bades_List.PNG]]

==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory

*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-18T20:10:44Z

Dpatel14: /* Snapshots */

==Problem Statement==

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

==Pre-Conditions==

These are the pre-conditions that needs to hold true for each functionality to work

:· The maximum number of students that can be assigned to the project cannot be more than 1.
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
:· Students can nominate for badges without providing a justification only if the instructor has not kept the justification field mandatory.

==Implementation Steps==

:· Provide professors an option to add all possible badges to a project.
:· Also provide the professor an option to make the justification field mandatory or not.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.

==Modifications To Be Done==

*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_badges_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page

*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
id: primary key
name: varchar
description: varchar

:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
Id: Primary key
assignment_id: foreign key
questionnaire_id: foreign key
badge_id: foreign key

==Execution Flow==
[[File:Oodd5.PNG]]

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

==Design==
[[File:Oodd2.PNG]]

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

==Snapshots==

Note: Currently the images contain dummy data because the data will be available from the project http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2_Lightweight_Badging_System
Below are the changes which are planned:

:·Added a new icon to the assignments which will redirect to a summary of the nominations for the assignment
[[File:Summary_Icon.PNG]]
:·The new view for the instructor where the instructor can see the list of nominations for the assignment (This will be in the path /assignments/:id/nominations)
[[File:New_View_For_Instructor.PNG]]
:·The instructor can decide whether to keep the justification mandatory or not. This will be added under the review strategy tab.
[[File:Instructor_Review_Strategy.jpg]]
:·The instructor can decide which badges to be allowed for nomination for the assignment from the list of all the available badges. Multiple selection is possible. This has been added as a new tab called "Available Badges for Nominations"
[[File:Nominations_Tab.PNG]]

[[File:Bades_List.PNG]]

==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory

*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-18T20:08:54Z

Dpatel14:

==Problem Statement==

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

==Pre-Conditions==

These are the pre-conditions that needs to hold true for each functionality to work

:· The maximum number of students that can be assigned to the project cannot be more than 1.
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
:· Students can nominate for badges without providing a justification only if the instructor has not kept the justification field mandatory.

==Implementation Steps==

:· Provide professors an option to add all possible badges to a project.
:· Also provide the professor an option to make the justification field mandatory or not.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.

==Modifications To Be Done==

*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_badges_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page

*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
id: primary key
name: varchar
description: varchar

:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
Id: Primary key
assignment_id: foreign key
questionnaire_id: foreign key
badge_id: foreign key

==Execution Flow==
[[File:Oodd5.PNG]]

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

==Design==
[[File:Oodd2.PNG]]

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

==Snapshots==
Below are the changes which are planned:

:·Added a new icon to the assignments which will redirect to a summary of the nominations for the assignment
[[File:Summary_Icon.PNG]]
:·The new view for the instructor where the instructor can see the list of nominations for the assignment (This will be in the path /assignments/:id/nominations)
[[File:New_View_For_Instructor.PNG]]
:·The instructor can decide whether to keep the justification mandatory or not. This will be added under the review strategy tab.
[[File:Instructor_Review_Strategy.jpg]]
:·The instructor can decide which badges to be allowed for nomination for the assignment from the list of all the available badges. Multiple selection is possible. This has been added as a new tab called "Available Badges for Nominations"
[[File:Nominations_Tab.PNG]]
[[File:Bades_List.PNG]]

==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory

*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]

File:Bades List.PNG

2017-11-18T20:08:32Z

Dpatel14:

File:Nominations Tab.PNG

2017-11-18T20:07:14Z

Dpatel14:

File:Instructor Review Strategy.jpg

2017-11-18T20:04:18Z

Dpatel14:

File:New View For Instructor.PNG

2017-11-18T19:59:35Z

Dpatel14:

File:Summary Icon.PNG

2017-11-18T19:55:25Z

Dpatel14:

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-17T01:57:06Z

Dpatel14: /* Implementation Steps */

==Problem Statement==

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

==Pre-Conditions==

These are the pre-conditions that needs to hold true for each functionality to work

:· The maximum number of students that can be assigned to the project cannot be more than 1.
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
:· Students can nominate for badges without providing a justification only if the instructor has not kept the justification field mandatory.

==Implementation Steps==

:· Provide professors an option to add all possible badges to a project.
:· Also provide the professor an option to make the justification field mandatory or not.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.

==Modifications To Be Done==

*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_questionnaire_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page

*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
id: primary key
name: varchar
description: varchar

:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
Id: Primary key
assignment_id: foreign key
questionnaire_id: foreign key
badge_id: foreign key

==Execution Flow==
[[File:Oodd5.PNG]]

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

==Design==
[[File:Oodd2.PNG]]

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory

*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-17T01:56:02Z

Dpatel14: /* Pre-Conditions */

==Problem Statement==

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

==Pre-Conditions==

These are the pre-conditions that needs to hold true for each functionality to work

:· The maximum number of students that can be assigned to the project cannot be more than 1.
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
:· Students can nominate for badges without providing a justification only if the instructor has not kept the justification field mandatory.

==Implementation Steps==

:· Provide professors an option to add all possible badges to a project.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.

==Modifications To Be Done==

*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_questionnaire_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page

*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
id: primary key
name: varchar
description: varchar

:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
Id: Primary key
assignment_id: foreign key
questionnaire_id: foreign key
badge_id: foreign key

==Execution Flow==
[[File:Oodd5.PNG]]

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

==Design==
[[File:Oodd2.PNG]]

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory

*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-17T01:54:11Z

Dpatel14: /* Design */

==Problem Statement==

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

==Pre-Conditions==

These are the pre-conditions that needs to hold true for each functionality to work

:· The maximum number of students that can be assigned to the project cannot be more then 1.
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
:· For students to be able to nominate badged without justification only if the project does not have a mandatory justification requirement.

==Implementation Steps==

:· Provide professors an option to add all possible badges to a project.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.

==Modifications To Be Done==

*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_questionnaire_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page

*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
id: primary key
name: varchar
description: varchar

:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
Id: Primary key
assignment_id: foreign key
questionnaire_id: foreign key
badge_id: foreign key

==Execution Flow==
[[File:Oodd5.PNG]]

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

==Design==
[[File:Oodd2.PNG]]

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory

*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-17T01:54:02Z

Dpatel14: /* Design */

==Problem Statement==

The purpose of the project is to implement a way to allow students to nominate badges to other students while reviewing their work. The professor should also be able to see the nominations to each student in a single page.

==Pre-Conditions==

These are the pre-conditions that needs to hold true for each functionality to work

:· The maximum number of students that can be assigned to the project cannot be more then 1.
:· For students to nominate badges, the professor must have provided a list of pre-decided badges possible for that project.
:· For students to be able to nominate badged without justification only if the project does not have a mandatory justification requirement.

==Implementation Steps==

:· Provide professors an option to add all possible badges to a project.
:· Allow students to nominate badges while peer reviewing.
:· Show a summary of all nominated badges to professor in a single page.

==Modifications To Be Done==

*Files to be Modified
:· Add the code to include the selection of relevant badges and the justification text box Assignment_questionnaire_controller.rb.
:· Add the badges model to assignment_questionnaire.rb.
:· Add the code to display the nomination summary on the page student_task/list page

*Tables to be Modified
:· We’ll be creating a table named “badges”, with the following attributes:
id: primary key
name: varchar
description: varchar

:· We’ll be creating a table named “assignment_questionnaires_badges”, with the following attributes:
Id: Primary key
assignment_id: foreign key
questionnaire_id: foreign key
badge_id: foreign key

==Execution Flow==
[[File:Oodd5.PNG]]

Once the instructor logs in, they can either select badges for existing assignments or go to a view which displays all the nominations.

Once the instructor selects the badges for the existing assignments, the students can login and provide nominations for badges during peer review.

==Design==
[[File:Oodd2.PNG]]

An instructor can add a badge to the badges table which will be also added to an assignment table as a probable nomination badge. The instructor can also view all the nominations done by the students during the peer review of an assignment.

The students on the other hand, while doing the peer review, can provide nominations for badges provided by the instructor for a particular assignment.

==Test Plan==
We will be creating test cases in the files
:·peer review.rb :Check with peer reviewer will be able to nominate badges
:·review_assignment_spec.rb:Check whether user is able to review assignment with Team Size=1
:·team_creation_spec.rb:Check the Team Size
:·review_mapping_spec.rb:Check whether reviewer is correctly mapped to the enrolled course
:·Write feature tests to verify the modifications:Include tests in the a new badge_system_spec.rb file in the spec/features directory

*UI design Testing:
:·Check if peer reviewer is able to nominate for badges with drop down list and contains text boxes for justification.
:·Check if instructor is able to view the summary of all nominations.
:·Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

==Reference Links==
*[https://github.com/expertiza/expertiza/tree/master/app/views Expertiza Github Master Branch]
*[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2015_E1575_Share_the_data_in_Expertiza_to_a_remote_server_via_PRML_format Expertiza Database Schema]

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-17T01:50:24Z

Dpatel14: /* Execution Flow */

CSC/ECE 517 Fall 2017/E17AA Nomination for Badges

2017-11-17T01:50:14Z

Dpatel14: /* Execution Flow */

CSC/ECE 517 Fall 2017/E1771 Refactor team.rb

2017-11-05T22:02:53Z

Dpatel14:

== Introduction ==
Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU.
== Mentor and Members ==
'''Mentor: Zhewei Hu (zhu6@ncsu.edu)'''

1. Darshil Patel (dpatel14@ncsu.edu)

2. Srujan Barai (sjbarai@ncsu.edu)

3. Shikhar Sharma (ssharm29@ncsu.edu)
== About team.rb ==
team.rb is the default class to interact with the team table. team.rb has 2 subclasses assignment_team.rb and course_team.rb.
== Issue ==
team.rb is a fairly complex file. It contains a lot of methods that are long and hard to understand.
These methods need to be broken down into simpler and more specific methods that are easier to read/understand. Also, the few instances of code duplication that exist should be removed
== Tasks accomplished ==
· Refactor self.randomize_all_by_parent method
· Split into several simpler methods and assign reasonable names
· Extract duplicated code into separate methods
· Rename method and change all other places it is used
· has_user → user?
· get_node_type → node_type
· get_author_names → author_names
· Pass &:destroy as an argument to each instead of a block
· L22
· Use find_by instead of dynamic method
· L63, L153, L162
· Use find_by instead of where.first
· L166, L181
· Complete the pending tests in team_spec.rb, and write integration tests for newly-created methods. Refactor corresponding methods, and only then finish pending tests.
Elaborating the edits made:
== Refactor self.randomize_all_by_parent method ==
Previous code:
def self.randomize_all_by_parent(parent, team_type, min_team_size)
participants = Participant.where(parent_id: parent.id, type: parent.class.to_s + "Participant")
participants = participants.sort { rand(3) - 1 }
users = participants.map {|p| User.find(p.user_id) }.to_a
# find teams still need team members and users who are not in any team
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + "Team").to_a
teams_num = teams.size
i = 0
teams_num.times do
teams_users = TeamsUser.where(team_id: teams[i].id)
teams_users.each do |teams_user|
users.delete(User.find(teams_user.user_id))
end
if Team.size(teams.first.id) >= min_team_size
teams.delete(teams.first)
else
i += 1
end
end
# sort teams by decreasing team size
teams.sort_by {|team| Team.size(team.id) }.reverse!
# insert users who are not in any team to teams still need team members
if !users.empty? and !teams.empty?
teams.each do |team|
curr_team_size = Team.size(team.id)
member_num_difference = min_team_size - curr_team_size
for i in (1..member_num_difference).to_a
team.add_member(users.first, parent.id)
users.delete(users.first)
break if users.empty?
end
break if users.empty?
end
end
# If all the existing teams are fill to the min_team_size and we still have more users, create teams for them.
unless users.empty?
num_of_teams = users.length.fdiv(min_team_size).ceil
nextTeamMemberIndex = 0
for i in (1..num_of_teams).to_a
team = Object.const_get(team_type + 'Team').create(name: "Team" + i.to_s, parent_id: parent.id)
TeamNode.create(parent_id: parent.id, node_object_id: team.id)
min_team_size.times do
break if nextTeamMemberIndex >= users.length
user = users[nextTeamMemberIndex]
team.add_member(user, parent.id)
nextTeamMemberIndex += 1
end
end
end
end
This method has been edited and divided into following methods:
== sort_teams_by_members_reverse() ==
def self.sort_teams_by_members_reverse(teams)
teams.sort_by { |team| Team.size(team.id) }.reverse!
end
== assign_single_users_to_teams ==
def self.assign_single_users_to_teams(min_team_size, parent, teams, users)
teams.each do |team|
curr_team_size = Team.size(team.id)
member_num_difference = min_team_size - curr_team_size
for i in (1..member_num_difference).to_a
team.add_member(users.first, parent.id)
users.delete(users.first)
break if users.empty?
end
break if users.empty?
end
end
== create_team_from_single_users ==
def self.create_team_from_single_users(min_team_size, parent, team_type, users)
num_of_teams = users.length.fdiv(min_team_size).ceil
nextTeamMemberIndex = 0
for i in (1..num_of_teams).to_a
team = Object.const_get(team_type + 'Team').create(name: "Team" + i.to_s, parent_id: parent.id)
TeamNode.create(parent_id: parent.id, node_object_id: team.id)
min_team_size.times do
break if nextTeamMemberIndex >= users.length
user = users[nextTeamMemberIndex]
team.add_member(user, parent.id)
nextTeamMemberIndex += 1
end
end
end
== Rename method and change all other places it is used ==
Renamed the methods '''has_user to user?''', '''get_node_type → node_type''' and '''get_author_names → author_names''' and also updated the function calls so that they call the correct (newly renamed) methods
== Pass &:destroy as an argument to each instead of a block ==
TeamsUser.where(team_id: self.id).each{ |teams_user| teams_user.destroy }
was refactored to
TeamsUser.where(team_id: self.id).each(&:destroy)
== Use find_by instead of dynamic method ==
parent = TeamNode.find_by_node_object_id(self.id)

return team_name unless Team.find_by_name(team_name)

user = User.find_by_name(row[index].to_s.strip)

were changed to
parent = TeamNode.find_by(node_object_id: self.id)

return team_name unless Team.find_by(name: team_name)

user = User.find_by(name: row[index].to_s.strip)
== Use find_by instead of where.first ==
participant = AssignmentParticipant.where(user_id: user.id, parent_id: self.parent_id).first

if AssignmentParticipant.where(parent_id: assignment_id, user_id: user.id).first.nil?

if CourseParticipant.where(parent_id: course_id, user_id: user.id).first.nil?

were updated to
participant = AssignmentParticipant.find_by(user_id: user.id, parent_id: self.parent_id)

if AssignmentParticipant.find_by(parent_id: assignment_id, user_id: user.id).nil?

if CourseParticipant.find_by(parent_id: course_id, user_id: user.id).nil?

== Test Cases ==
We have completed all the pending tests in the file team_spec.rb and all the test cases are passing. This can be checked in the pull request which is linked below.

== Pull Request ==
Github Link to Pull Request: [https://github.com/expertiza/expertiza/pull/1043]

CSC/ECE 517 Fall 2017/E1771 Refactor team.rb

2017-11-05T21:28:37Z

Dpatel14:

== Introduction ==

Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU.

== Mentor and Members ==
'''Mentor: Zhewei Hu (zhu6@ncsu.edu)'''

1. Darshil Patel (dpatel14@ncsu.edu)

2. Srujan Barai (sjbarai@ncsu.edu)

3. Shikhar Sharma (ssharm29@ncsu.edu)

== About team.rb ==

team.rb is the default class to interact with the team table. team.rb has 2 subclasses assignment_team.rb and course_team.rb.

== Issue ==

team.rb is a fairly complex file. It contains a lot of methods that are long and hard to understand.
These methods need to be broken down into simpler and more specific methods that are easier to read/understand. Also, the few instances of code duplication that exist should be removed

== Tasks accomplished ==

· Refactor self.randomize_all_by_parent method
· Split into several simpler methods and assign reasonable names
· Extract duplicated code into separate methods
· Rename method and change all other places it is used
· has_user → user?
· get_node_type → node_type
· get_author_names → author_names
· Pass &:destroy as an argument to each instead of a block
· L22
· Use find_by instead of dynamic method
· L63, L153, L162
· Use find_by instead of where.first
· L166, L181
· Complete the pending tests in team_spec.rb, and write integration tests for newly-created methods. Refactor corresponding methods, and only then finish pending tests.

Elaborating the edits made:

== Refactor self.randomize_all_by_parent method ==

Previous code:

def self.randomize_all_by_parent(parent, team_type, min_team_size)
participants = Participant.where(parent_id: parent.id, type: parent.class.to_s + "Participant")
participants = participants.sort { rand(3) - 1 }
users = participants.map {|p| User.find(p.user_id) }.to_a
# find teams still need team members and users who are not in any team
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + "Team").to_a
teams_num = teams.size
i = 0
teams_num.times do
teams_users = TeamsUser.where(team_id: teams[i].id)
teams_users.each do |teams_user|
users.delete(User.find(teams_user.user_id))
end
if Team.size(teams.first.id) >= min_team_size
teams.delete(teams.first)
else
i += 1
end
end
# sort teams by decreasing team size
teams.sort_by {|team| Team.size(team.id) }.reverse!
# insert users who are not in any team to teams still need team members
if !users.empty? and !teams.empty?
teams.each do |team|
curr_team_size = Team.size(team.id)
member_num_difference = min_team_size - curr_team_size
for i in (1..member_num_difference).to_a
team.add_member(users.first, parent.id)
users.delete(users.first)
break if users.empty?
end
break if users.empty?
end
end
# If all the existing teams are fill to the min_team_size and we still have more users, create teams for them.
unless users.empty?
num_of_teams = users.length.fdiv(min_team_size).ceil
nextTeamMemberIndex = 0
for i in (1..num_of_teams).to_a
team = Object.const_get(team_type + 'Team').create(name: "Team" + i.to_s, parent_id: parent.id)
TeamNode.create(parent_id: parent.id, node_object_id: team.id)
min_team_size.times do
break if nextTeamMemberIndex >= users.length
user = users[nextTeamMemberIndex]
team.add_member(user, parent.id)
nextTeamMemberIndex += 1
end
end
end
end

This method has been edited and divided into following methods:

== sort_teams_by_members_reverse() ==

def self.sort_teams_by_members_reverse(teams)
teams.sort_by { |team| Team.size(team.id) }.reverse!
end

== assign_single_users_to_teams ==

def self.assign_single_users_to_teams(min_team_size, parent, teams, users)
teams.each do |team|
curr_team_size = Team.size(team.id)
member_num_difference = min_team_size - curr_team_size
for i in (1..member_num_difference).to_a
team.add_member(users.first, parent.id)
users.delete(users.first)
break if users.empty?
end
break if users.empty?
end
end

== create_team_from_single_users ==

def self.create_team_from_single_users(min_team_size, parent, team_type, users)
num_of_teams = users.length.fdiv(min_team_size).ceil
nextTeamMemberIndex = 0
for i in (1..num_of_teams).to_a
team = Object.const_get(team_type + 'Team').create(name: "Team" + i.to_s, parent_id: parent.id)
TeamNode.create(parent_id: parent.id, node_object_id: team.id)
min_team_size.times do
break if nextTeamMemberIndex >= users.length
user = users[nextTeamMemberIndex]
team.add_member(user, parent.id)
nextTeamMemberIndex += 1
end
end
end

== Pull Request ==
Github Link to Pull Request: [https://github.com/expertiza/expertiza/pull/1043]

CSC/ECE 517 Fall 2017

2017-11-05T21:22:19Z

Dpatel14:

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]

'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]

CSC/ECE 517 Fall 2017/E1771 Refactor team.rb

2017-10-30T19:55:20Z

Dpatel14:

== Introduction ==

Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU.

== About team.rb ==

team.rb is the default class to interact with the team table. team.rb has 2 subclasses assignment_team.rb and course_team.rb.

== Issue ==

team.rb is a fairly complex file. It contains a lot of methods that are long and hard to understand.
These methods need to be broken down into simpler and more specific methods that are easier to read/understand. Also, the few instances of code duplication that exist should be removed

== Tasks accomplished ==

· Refactor self.randomize_all_by_parent method
· Split into several simpler methods and assign reasonable names
· Extract duplicated code into separate methods
· Rename method and change all other places it is used
· has_user → user?
· get_node_type → node_type
· get_author_names → author_names
· Pass &:destroy as an argument to each instead of a block
· L22
· Use find_by instead of dynamic method
· L63, L153, L162
· Use find_by instead of where.first
· L166, L181
· Complete the pending tests in team_spec.rb, and write integration tests for newly-created methods. Refactor corresponding methods, and only then finish pending tests.

Elaborating the edits made:

== Refactor self.randomize_all_by_parent method ==

Previous code:

def self.randomize_all_by_parent(parent, team_type, min_team_size)
participants = Participant.where(parent_id: parent.id, type: parent.class.to_s + "Participant")
participants = participants.sort { rand(3) - 1 }
users = participants.map {|p| User.find(p.user_id) }.to_a
# find teams still need team members and users who are not in any team
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + "Team").to_a
teams_num = teams.size
i = 0
teams_num.times do
teams_users = TeamsUser.where(team_id: teams[i].id)
teams_users.each do |teams_user|
users.delete(User.find(teams_user.user_id))
end
if Team.size(teams.first.id) >= min_team_size
teams.delete(teams.first)
else
i += 1
end
end
# sort teams by decreasing team size
teams.sort_by {|team| Team.size(team.id) }.reverse!
# insert users who are not in any team to teams still need team members
if !users.empty? and !teams.empty?
teams.each do |team|
curr_team_size = Team.size(team.id)
member_num_difference = min_team_size - curr_team_size
for i in (1..member_num_difference).to_a
team.add_member(users.first, parent.id)
users.delete(users.first)
break if users.empty?
end
break if users.empty?
end
end
# If all the existing teams are fill to the min_team_size and we still have more users, create teams for them.
unless users.empty?
num_of_teams = users.length.fdiv(min_team_size).ceil
nextTeamMemberIndex = 0
for i in (1..num_of_teams).to_a
team = Object.const_get(team_type + 'Team').create(name: "Team" + i.to_s, parent_id: parent.id)
TeamNode.create(parent_id: parent.id, node_object_id: team.id)
min_team_size.times do
break if nextTeamMemberIndex >= users.length
user = users[nextTeamMemberIndex]
team.add_member(user, parent.id)
nextTeamMemberIndex += 1
end
end
end
end

This method has been edited and divided into following methods:

== sort_teams_by_members_reverse() ==

def self.sort_teams_by_members_reverse(teams)
teams.sort_by { |team| Team.size(team.id) }.reverse!
end

== assign_single_users_to_teams ==

def self.assign_single_users_to_teams(min_team_size, parent, teams, users)
teams.each do |team|
curr_team_size = Team.size(team.id)
member_num_difference = min_team_size - curr_team_size
for i in (1..member_num_difference).to_a
team.add_member(users.first, parent.id)
users.delete(users.first)
break if users.empty?
end
break if users.empty?
end
end

== create_team_from_single_users ==

def self.create_team_from_single_users(min_team_size, parent, team_type, users)
num_of_teams = users.length.fdiv(min_team_size).ceil
nextTeamMemberIndex = 0
for i in (1..num_of_teams).to_a
team = Object.const_get(team_type + 'Team').create(name: "Team" + i.to_s, parent_id: parent.id)
TeamNode.create(parent_id: parent.id, node_object_id: team.id)
min_team_size.times do
break if nextTeamMemberIndex >= users.length
user = users[nextTeamMemberIndex]
team.add_member(user, parent.id)
nextTeamMemberIndex += 1
end
end
end

== Pull Request ==
Github Link to Pull Request: [https://github.com/expertiza/expertiza/pull/1043]