Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-30T04:48:16Z

Krschulz:

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments was considered. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed the same way that the instructor had reviewed the assignment. Calibration assignments show whether or not the student had given the same or similar score as the instructor for rubric items.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in two ways:

====1. Check "Calibration for training?" in the general tab of an assignment then copy the participants from the course.====

[[File:2021-11-03 011751.png]]

====2. Copy existing assignment and its participants with calibration review enabled.====

Detailed System Overview can be found at the following: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues with the Previous work===
#The project assumes that calibration submissions starts at directory 0, which is only correct if the users who submit the calibration submissions are the first to be added as participants to the assignment.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.
#The due date of calibration review are missing. [[File:2021-11-03 235457.png]]
#The copied assignments do not have participants copied. [[File:2021-11-04 013403.png]]

==Design==
#TODO: add UML diagram, preliminary class design
[[File:2021-11-04 230435.png]]

==Implementation==
===Files we originally planned to modify===
#app/controllers/student_review_controller.rb<br/>The mappings of reviews or calibration reviews should be redesigned.
#views/student_review/list.html.erb<br/>The view of the list should be modified so that the calibration review can be displayed correctly.
#views/assignments/edit/_due_dates.html.erb<br/>
#app/models/deadline_right.rb
#app/controllers/assignments_controller.rb<br/>The assignments_controller might need a fix so that the assignments with calibration review can be deleted properly.
#app/views/student_review/_responses.html.erb

===Files we modified===
#app/models/assignment_form.rb
##Removed vary_by_topic_desired from the update function.
##Removed topic references from update_assignment_questionnaires.
##Updated Questionnaire to AssignmentQuestionnaire.
##Added self.copy_calibration function.
##Updated the copy counter.
#app/models/assignment_team.rb
##Removed code for E1973.
##Updated review response map return.
##Created directory_path function.
#app/models/deadline_right.rb
##Added calibration to the model.
#app/models/participant.rb
##Added self.createparticipant function.
#app/models/review_response_map.rb
##Removed E1973 code.
##Removed topic from questionnaire function.
##Shortened self.import function.
##Added self.newreviewresp function.
#app/models/submission_record.rb
##Added self.copycalibratedsubmissions function.
#app/models/team.rb
##Added self.createnewteam function.
#app/views/assignments/edit/_due_dates.html.erb
##Added checkmark for calibration.
#spec/features/assignment_creation_general_tab_spec.rb
##See tests section.
#spec/models/assignment_form_spec.rb
##See tests section.
#db/migrate/20211129124620_add_calibration_to_deadline_type.rb
##We added a new migration for AddCalibrationToDeadlineType.

==Testing Plan==

#Unit test files added:
##spec/models/assignment_form_spec.rb
###Added tests for function 'copy'. Test to make sure that the assignment id is updated on copy and no longer references the original assignment. We also make sure that the name of the new file is correct.
##spec/features/assignment_creation_general_tab_spec.rb
###Added unit test to make sure that the calibration shows in the due dates tab.

Testing scenarios:

#The instructor copies the existing assignment<br />The copied assignment stored in the correct directory<br />Expect the number of calibration submitters of the copied assignment=the number of participants of the original assignment
#The instructor enables the calibration review of an assignment<br />The calibration tab appears next to the due dates tab
#The student attempts his/her calibration review<br />The student submits the calibration review<br />The webpage shows what the student has submitted as well as a long that says "Show Calibration Results".

==Errors Found==

We found, and fixed, a bug in app/controllers/response_controller.rb where the code was using get_reviewer instead of reviewer. We needed to fix this bug in order for our code to work.

==Future Improvements==

We believe that submitter_count can be removed from the database since it is never used in the project and in order to update the student directory number we do set_student_directory_num on any of team object within an assignment.

==Links==
[https://github.com/Kasimir123/expertiza/tree/beta Github repository]

==Team==
#John Marsden (ProfDoof)
#Lee Shyu (ls-hyu)
#Angela Ho (angelaho0504)
#Kasimir Schulz (Kasimir123)

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-30T04:34:50Z

Krschulz: /* Files we modified */

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments was considered. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed the same way that the instructor had reviewed the assignment. Calibration assignments show whether or not the student had given the same or similar score as the instructor for rubric items.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in two ways:

====1. Check "Calibration for training?" in the general tab of an assignment then copy the participants from the course.====

[[File:2021-11-03 011751.png]]

====2. Copy existing assignment and its participants with calibration review enabled.====

Detailed System Overview can be found at the following: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues with the Previous work===
#The project assumes that calibration submissions starts at directory 0, which is only correct if the users who submit the calibration submissions are the first to be added as participants to the assignment.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.
#The due date of calibration review are missing. [[File:2021-11-03 235457.png]]
#The copied assignments do not have participants copied. [[File:2021-11-04 013403.png]]

==Design==
#TODO: add UML diagram, preliminary class design
[[File:2021-11-04 230435.png]]

==Implementation==
===Files we originally planned to modify===
#app/controllers/student_review_controller.rb<br/>The mappings of reviews or calibration reviews should be redesigned.
#views/student_review/list.html.erb<br/>The view of the list should be modified so that the calibration review can be displayed correctly.
#views/assignments/edit/_due_dates.html.erb<br/>
#app/models/deadline_right.rb
#app/controllers/assignments_controller.rb<br/>The assignments_controller might need a fix so that the assignments with calibration review can be deleted properly.
#app/views/student_review/_responses.html.erb

===Files we modified===
#app/models/assignment_form.rb
##Removed vary_by_topic_desired from the update function.
##Removed topic references from update_assignment_questionnaires.
##Updated Questionnaire to AssignmentQuestionnaire.
##Added self.copy_calibration function.
##Updated the copy counter.
#app/models/assignment_team.rb
##Removed code for E1973.
##Updated review response map return.
##Created directory_path function.
#app/models/deadline_right.rb
##Added calibration to the model.
#app/models/participant.rb
##Added self.createparticipant function.
#app/models/review_response_map.rb
##Removed E1973 code.
##Removed topic from questionnaire function.
##Shortened self.import function.
##Added self.newreviewresp function.
#app/models/submission_record.rb
##Added self.copycalibratedsubmissions function.
#app/models/team.rb
##Added self.createnewteam function.
#app/views/assignments/edit/_due_dates.html.erb
##Added checkmark for calibration.
#spec/features/assignment_creation_general_tab_spec.rb
##See tests section.
#spec/models/assignment_form_spec.rb
##See tests section.
#db/migrate/20211129124620_add_calibration_to_deadline_type.rb
##We added a new migration for AddCalibrationToDeadlineType.

==Testing Plan==

#Unit test files added:
##spec/models/assignment_form_spec.rb
###Added tests for function 'copy'. Test to make sure that the assignment id is updated on copy and no longer references the original assignment. We also make sure that the name of the new file is correct.
##spec/features/assignment_creation_general_tab_spec.rb
###Added unit test to make sure that the calibration shows in the due dates tab.

Testing scenarios:

#The instructor copies the existing assignment<br />The copied assignment stored in the correct directory<br />Expect the number of calibration submitters of the copied assignment=the number of participants of the original assignment
#The instructor enables the calibration review of an assignment<br />The calibration tab appears next to the due dates tab
#The student attempts his/her calibration review<br />The student submits the calibration review<br />The webpage shows what the student has submitted as well as a long that says "Show Calibration Results".

==Future Improvements==

We believe that submitter_count can be removed from the database since it is never used in the project and in order to update the student directory number we do set_student_directory_num on any of team object within an assignment.

==Links==
[https://github.com/Kasimir123/expertiza/tree/beta Github repository]

==Team==
#John Marsden (ProfDoof)
#Lee Shyu (ls-hyu)
#Angela Ho (angelaho0504)
#Kasimir Schulz (Kasimir123)

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-30T04:05:15Z

Krschulz:

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments was considered. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed the same way that the instructor had reviewed the assignment. Calibration assignments show whether or not the student had given the same or similar score as the instructor for rubric items.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in two ways:

====1. Check "Calibration for training?" in the general tab of an assignment then copy the participants from the course.====

[[File:2021-11-03 011751.png]]

====2. Copy existing assignment and its participants with calibration review enabled.====

Detailed System Overview can be found at the following: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues with the Previous work===
#The project assumes that calibration submissions starts at directory 0, which is only correct if the users who submit the calibration submissions are the first to be added as participants to the assignment.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.
#The due date of calibration review are missing. [[File:2021-11-03 235457.png]]
#The copied assignments do not have participants copied. [[File:2021-11-04 013403.png]]

==Design==
#TODO: add UML diagram, preliminary class design
[[File:2021-11-04 230435.png]]

==Implementation==
===Files we originally planned to modify===
#app/controllers/student_review_controller.rb<br/>The mappings of reviews or calibration reviews should be redesigned.
#views/student_review/list.html.erb<br/>The view of the list should be modified so that the calibration review can be displayed correctly.
#views/assignments/edit/_due_dates.html.erb<br/>
#app/models/deadline_right.rb
#app/controllers/assignments_controller.rb<br/>The assignments_controller might need a fix so that the assignments with calibration review can be deleted properly.
#app/views/student_review/_responses.html.erb

===Files we modified===
#app/models/assignment_form.rb
##Removed vary_by_topic_desired from the update function.
##Removed topic references from update_assignment_questionnaires.
##Updated Questionnaire to AssignmentQuestionnaire.
##Added self.copy_calibration function.
##Updated the copy counter.
#app/models/assignment_team.rb
##Removed code for E1973.
##Updated review response map return.
##Created directory_path function.
#app/models/deadline_right.rb
##Added calibration to the model.
#app/models/participant.rb
##Added self.createparticipant function.
#app/models/review_response_map.rb
##Removed E1973 code.
##Removed topic from questionnaire function.
##Shortened self.import function.
##Added self.newreviewresp function.
#app/models/submission_record.rb
##Added self.copycalibratedsubmissions function.
#app/models/team.rb
##Added self.createnewteam function.
#app/views/assignments/edit/_due_dates.html.erb
##Added checkmark for calibration.
#spec/features/assignment_creation_general_tab_spec.rb
##See tests section.
#spec/models/assignment_form_spec.rb
##See tests section.

==Testing Plan==

#Unit test files added:
##spec/models/assignment_form_spec.rb
###Added tests for function 'copy'. Test to make sure that the assignment id is updated on copy and no longer references the original assignment. We also make sure that the name of the new file is correct.
##spec/features/assignment_creation_general_tab_spec.rb
###Added unit test to make sure that the calibration shows in the due dates tab.

Testing scenarios:

#The instructor copies the existing assignment<br />The copied assignment stored in the correct directory<br />Expect the number of calibration submitters of the copied assignment=the number of participants of the original assignment
#The instructor enables the calibration review of an assignment<br />The calibration tab appears next to the due dates tab
#The student attempts his/her calibration review<br />The student submits the calibration review<br />The webpage shows what the student has submitted as well as a long that says "Show Calibration Results".

==Future Improvements==

We believe that submitter_count can be removed from the database since it is never used in the project and in order to update the student directory number we do set_student_directory_num on any of team object within an assignment.

==Links==
[https://github.com/Kasimir123/expertiza/tree/beta Github repository]

==Team==
#John Marsden (ProfDoof)
#Lee Shyu (ls-hyu)
#Angela Ho (angelaho0504)
#Kasimir Schulz (Kasimir123)

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-30T03:58:44Z

Krschulz: /* Files we plan to modify */

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments was considered. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed the same way that the instructor had reviewed the assignment. Calibration assignments show whether or not the student had given the same or similar score as the instructor for rubric items.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in two ways:

====1. Check "Calibration for training?" in the general tab of an assignment then copy the participants from the course.====

[[File:2021-11-03 011751.png]]

====2. Copy existing assignment and its participants with calibration review enabled.====

Detailed System Overview can be found at the following: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues with the Previous work===
#The project assumes that calibration submissions starts at directory 0, which is only correct if the users who submit the calibration submissions are the first to be added as participants to the assignment.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.
#The due date of calibration review are missing. [[File:2021-11-03 235457.png]]
#The copied assignments do not have participants copied. [[File:2021-11-04 013403.png]]

==Design==
#TODO: add UML diagram, preliminary class design
[[File:2021-11-04 230435.png]]

==Implementation==
===Files we originally planned to modify===
#app/controllers/student_review_controller.rb<br/>The mappings of reviews or calibration reviews should be redesigned.
#views/student_review/list.html.erb<br/>The view of the list should be modified so that the calibration review can be displayed correctly.
#views/assignments/edit/_due_dates.html.erb<br/>
#app/models/deadline_right.rb
#app/controllers/assignments_controller.rb<br/>The assignments_controller might need a fix so that the assignments with calibration review can be deleted properly.
#app/views/student_review/_responses.html.erb

===Files we modified===
#app/models/assignment_form.rb
##Removed vary_by_topic_desired from the update function.
##Removed topic references from update_assignment_questionnaires.
##Updated Questionnaire to AssignmentQuestionnaire.
##Added self.copy_calibration function.
##Updated the copy counter.
#app/models/assignment_team.rb
##Removed code for E1973.
##Updated review response map return.
##Created directory_path function.
#app/models/deadline_right.rb
##Added calibration to the model.
#app/models/participant.rb
##Added self.createparticipant function.
#app/models/review_response_map.rb
##Removed E1973 code.
##Removed topic from questionnaire function.
##Shortened self.import function.
##Added self.newreviewresp function.
#app/models/submission_record.rb
##Added self.copycalibratedsubmissions function.
#app/models/team.rb
##Added self.createnewteam function.
#app/views/assignments/edit/_due_dates.html.erb
##Added checkmark for calibration.
#spec/features/assignment_creation_general_tab_spec.rb
##See tests section.
#spec/models/assignment_form_spec.rb
##See tests section.

==Testing Plan==

#Unit test files added:
##spec/models/assignment_form_spec.rb
###Added tests for function 'copy'. Test to make sure that the assignment id is updated on copy and no longer references the original assignment. We also make sure that the name of the new file is correct.
##spec/features/assignment_creation_general_tab_spec.rb
###Added unit test to make sure that the calibration shows in the due dates tab.

Testing scenarios:

#The instructor copies the existing assignment<br />The copied assignment stored in the correct directory<br />Expect the number of calibration submitters of the copied assignment=the number of participants of the original assignment
#The instructor enables the calibration review of an assignment<br />The calibration tab appears next to the due dates tab
#The student attempts his/her calibration review<br />The student submits the calibration review<br />The webpage shows what the student has submitted as well as a long that says "Show Calibration Results".

==Links==
[https://github.com/Kasimir123/expertiza/tree/beta Github repository]

==Team==
#John Marsden (ProfDoof)
#Lee Shyu (ls-hyu)
#Angela Ho (angelaho0504)
#Kasimir Schulz (Kasimir123)

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-30T03:39:26Z

Krschulz: /* Testing Plan */

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments was considered. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed the same way that the instructor had reviewed the assignment. Calibration assignments show whether or not the student had given the same or similar score as the instructor for rubric items.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in two ways:

====1. Check "Calibration for training?" in the general tab of an assignment then copy the participants from the course.====

[[File:2021-11-03 011751.png]]

====2. Copy existing assignment and its participants with calibration review enabled.====

Detailed System Overview can be found at the following: <br>
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues with the Previous work===
#The project assumes that calibration submissions starts at directory 0, which is only correct if the users who submit the calibration submissions are the first to be added as participants to the assignment.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.
#The due date of calibration review are missing. [[File:2021-11-03 235457.png]]
#The copied assignments do not have participants copied. [[File:2021-11-04 013403.png]]

==Design==
#TODO: add UML diagram, preliminary class design
[[File:2021-11-04 230435.png]]

==Implementation==
===Files we plan to modify===
#app/controllers/student_review_controller.rb<br/>The mappings of reviews or calibration reviews should be redesigned.
#views/student_review/list.html.erb<br/>The view of the list should be modified so that the calibration review can be displayed correctly.
#views/assignments/edit/_due_dates.html.erb<br/>
#app/models/deadline_right.rb
#app/controllers/assignments_controller.rb<br/>The assignments_controller might need a fix so that the assignments with calibration review can be deleted properly.
#app/views/student_review/_responses.html.erb

==Testing Plan==

#Unit test files added:
##spec/models/assignment_form_spec.rb
###Added tests for function 'copy'. Test to make sure that the assignment id is updated on copy and no longer references the original assignment. We also make sure that the name of the new file is correct.
##spec/features/assignment_creation_general_tab_spec.rb
###Added unit test to make sure that the calibration shows in the due dates tab.

Testing scenarios:

#The instructor copies the existing assignment<br />The copied assignment stored in the correct directory<br />Expect the number of calibration submitters of the copied assignment=the number of participants of the original assignment
#The instructor enables the calibration review of an assignment<br />The calibration tab appears next to the due dates tab
#The student attempts his/her calibration review<br />The student submits the calibration review<br />The webpage shows what the student has submitted as well as a long that says "Show Calibration Results".

==Links==
[https://github.com/Kasimir123/expertiza/tree/beta Github repository]

==Team==
#John Marsden (ProfDoof)
#Lee Shyu (ls-hyu)
#Angela Ho (angelaho0504)
#Kasimir Schulz (Kasimir123)

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-08T22:22:26Z

Krschulz: /* Testing Plan */

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-08T22:21:26Z

Krschulz: /* Testing Plan */

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-08T22:20:16Z

Krschulz: /* Testing Plan */

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-08T22:18:40Z

Krschulz: /* Issues of Previous work */

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-08T22:17:29Z

Krschulz: /* Issues of Previous work */

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-08T22:16:08Z

Krschulz: /* 1. Check "Calibration for training?" in an assignment then copy the participants from the course. */

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-08T22:15:10Z

Krschulz: /* Background */

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-03T16:41:33Z

Krschulz: /* Issues of Previous work */

==Project Overview==
===Introduction===
#TODO: Rephrase the sentences
Expertiza is an open-source learning management system developed using Ruby on Rails framework. Expertiza supports multiple features such as course management, assignment submission, peer review, grade calculation, etc.

[https://expertiza.csc.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://expertiza.ncsu.edu/ Expertiza] is an open-source education and classroom web-tool founded by the [http://www.nsf.gov/ National Science Foundation]. Built with Ruby on Rails, it is designed to manage complete courses and students’ work within those courses. Each course can have a collection of instructors and students, though the interaction between instructors and students is minimal. The real emphasis of Expertiza is placed on peer-to-peer interactions, fostering a student-driven learning environment. Courses are comprised of assignments which users complete individually or with a team. Assignments usually encourage or require a team to enforce practicing peer-to-peer interaction.

===Background===
To improve the experience of peer reviewing and to find out the competent reviewers among all the reviewers, designing a new form of review for assignments seems to be a fix. As a result, "calibration assignment" was introduced to the Expertiza system. The calibration assignment should be assigned before the peer review so that the students can know if they reviewed using the same rubrics as the instructor.
To set up the calibration assignment that allows both the instructor and the students of the course to review, the instructor needs to create a new assignment and add the extra participant manually, impersonate the participant then submit the review, which is not a great experience.

===Objectives===
To fix the issue of setting up the calibration assignment repeatedly every semester, the system should be able to make a copy of the previous calibration assignment and let the instructor submit a review as the extra participant by selecting calibration training when the instructor creates the assignment.

===Previous Implementation===
In the previous implementation, the calibration review was designed as part of the assignment and students should be able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in each assignment by checking the box before "Calibration for training?".

[[File:2021-11-03 011751.png]]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

===Issues of Previous work===
#The project assumes that the calibration starts at directory 0 which causes the wrong submission to be copied occasionally.
##Suggested Fix: set submitter_count to the largest directory number that was used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.

==Design==

==Implementation==

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T22:06:48Z

Krschulz: /* Peer Review Information */

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.

====Peer Review Information====

----

Login credentials for peer review.

* Instructor login:
** Username: instructor6
** Password: password

* Student login:
** Username: student4340
** Password: password

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

Currently reviewing does not allow students to have different rubrics for an assignment based on their role in the team.

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

An authorized user can select the edit role icon or the name of a duty on the Review Strategy tab and will be redirected to a form (duty view) that is auto populated by the edit view for the duty they are attempting to edit:

[[File:Edit-duty.png]]

After successfully updating the duty the user is redirected back to the assignment edit page and get a notification of the change:

[[File:Edit-duty-confirmation.png]]

An authorized user can also delete an existing duty, after deletion they will get another notification:

[[File:Duty-deletion-confirmation.png]]

===Testing===

----

====RSPEC====

----

Since duties_controller was a brand new file we created a new spec files "duties_controller_spec.rb" which covers creation, editing, and deletion of duties in the system. To run this file use the following command while in the top level of the expertiza directory:

<pre>
rspec ./spec/controllers/duties_controller_spec.rb
</pre>

====UI====

----

'''The following steps need to be performed to test this code from the UI:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Save and exit the assignment.

6. Login as a student and attempt to apply to the duty.

'''To test editing of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the edit icon or the duty name listed under Role name.

7. Edit the duty, press Update and navigate to the Review Strategy tab again.

'''To test deleting of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the delete icon.

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

===References===

----

#[https://github.com/expertiza/expertiza Expertiza on GitHub]

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T22:06:38Z

Krschulz: Added login information

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T22:01:59Z

Krschulz: /* RSPEC */

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

Currently reviewing does not allow students to have different rubrics for an assignment based on their role in the team.

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

An authorized user can select the edit role icon or the name of a duty on the Review Strategy tab and will be redirected to a form (duty view) that is auto populated by the edit view for the duty they are attempting to edit:

[[File:Edit-duty.png]]

After successfully updating the duty the user is redirected back to the assignment edit page and get a notification of the change:

[[File:Edit-duty-confirmation.png]]

An authorized user can also delete an existing duty, after deletion they will get another notification:

[[File:Duty-deletion-confirmation.png]]

===Testing===

----

====RSPEC====

----

Since duties_controller was a brand new file we created a new spec files "duties_controller_spec.rb" which covers creation, editing, and deletion of duties in the system. To run this file use the following command while in the top level of the expertiza directory:

<pre>
rspec ./spec/controllers/duties_controller_spec.rb
</pre>

====UI====

----

'''The following steps need to be performed to test this code from the UI:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Save and exit the assignment.

6. Login as a student and attempt to apply to the duty.

'''To test editing of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the edit icon or the duty name listed under Role name.

7. Edit the duty, press Update and navigate to the Review Strategy tab again.

'''To test deleting of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the delete icon.

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

===References===

----

#[https://github.com/expertiza/expertiza Expertiza on GitHub]

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T20:08:02Z

Krschulz: /* Solutions Implemented and Delivered */

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

Currently reviewing does not allow students to have different rubrics for an assignment based on their role in the team.

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

An authorized user can select the edit role icon or the name of a duty on the Review Strategy tab and will be redirected to a form (duty view) that is auto populated by the edit view for the duty they are attempting to edit:

[[File:Edit-duty.png]]

After successfully updating the duty the user is redirected back to the assignment edit page and get a notification of the change:

[[File:Edit-duty-confirmation.png]]

An authorized user can also delete an existing duty, after deletion they will get another notification:

[[File:Duty-deletion-confirmation.png]]

===Testing===

----

====RSPEC====

====UI====

----

'''The following steps need to be performed to test this code from the UI:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Save and exit the assignment.

6. Login as a student and attempt to apply to the duty.

'''To test editing of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the edit icon or the duty name listed under Role name.

7. Edit the duty, press Update and navigate to the Review Strategy tab again.

'''To test deleting of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the delete icon.

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

===References===

----

#[https://github.com/expertiza/expertiza Expertiza on GitHub]

File:Duty-deletion-confirmation.png

2021-10-20T20:07:19Z

Krschulz: Confirmation that the duty has been deleted.

Confirmation that the duty has been deleted.

File:Edit-duty-confirmation.png

2021-10-20T20:05:23Z

Krschulz: Confirmation that the duty has been successfully updated.

Confirmation that the duty has been successfully updated.

File:Edit-duty.png

2021-10-20T20:02:29Z

Krschulz: Screen showing editing of a role/duty.

Screen showing editing of a role/duty.

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T19:43:57Z

Krschulz: /* E2147. Role-based reviewing */

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

Currently reviewing does not allow students to have different rubrics for an assignment based on their role in the team.

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

===Testing===

----

====RSPEC====

====UI====

----

'''The following steps need to be performed to test this code from the UI:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Save and exit the assignment.

6. Login as a student and attempt to apply to the duty.

'''To test editing of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the edit icon or the duty name listed under Role name.

7. Edit the duty, press Update and navigate to the Review Strategy tab again.

'''To test deleting of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the delete icon.

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

===References===

----

#[https://github.com/expertiza/expertiza Expertiza on GitHub]

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T19:43:40Z

Krschulz: /* About Expertiza */

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). The Expertiza project is supported by the National Science Foundation.

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

Currently reviewing does not allow students to have different rubrics for an assignment based on their role in the team.

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

===Testing===

----

====RSPEC====

====UI====

----

'''The following steps need to be performed to test this code from the UI:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Save and exit the assignment.

6. Login as a student and attempt to apply to the duty.

'''To test editing of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the edit icon or the duty name listed under Role name.

7. Edit the duty, press Update and navigate to the Review Strategy tab again.

'''To test deleting of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the delete icon.

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T19:39:02Z

Krschulz: /* About Current Reviewing */

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

Currently reviewing does not allow students to have different rubrics for an assignment based on their role in the team.

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

===Testing===

----

====RSPEC====

====UI====

----

'''The following steps need to be performed to test this code from the UI:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Save and exit the assignment.

6. Login as a student and attempt to apply to the duty.

'''To test editing of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the edit icon or the duty name listed under Role name.

7. Edit the duty, press Update and navigate to the Review Strategy tab again.

'''To test deleting of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the delete icon.

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T19:17:53Z

Krschulz: Added UI testing information

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

===Testing===

----

====RSPEC====

====UI====

----

'''The following steps need to be performed to test this code from the UI:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Save and exit the assignment.

6. Login as a student and attempt to apply to the duty.

'''To test editing of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the edit icon or the duty name listed under Role name.

7. Edit the duty, press Update and navigate to the Review Strategy tab again.

'''To test deleting of a duty:'''

1. Login as an instructor. Create a course and an assignment or navigate to an existing course with assignments.

2. Mark the assignment as a team assignment and navigate to the Review Strategy tab.

3. Check the Is Role-Based Reviewing checkbox and save the assignment.

4. Click New Role and fill out the information for creating a new duty.

5. Click create and navigate to the Review Strategy tab again.

6. Click either the delete icon.

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T19:00:31Z

Krschulz: Added some changes to make the page look better

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

----

===Problem Statement===

----

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

----

===Solutions Implemented and Delivered===

----

''Below we have listed the solutions that we implemented, why we did certain design decisions, and explanations on how they were implemented.''

'''Created a new database table, model, view, and controller for duties.'''

----

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''Allow assignments to be marked for role-based reviewing.'''

----

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''Certain users can add and edit roles for assignments.'''

----

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

===Testing===

----

====RSPEC====

====UI====

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T18:56:52Z

Krschulz: Added possible future improvements

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

===Problem Statement===

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

===Solutions Implemented and Delivered===

'''* Created a new database table, model, view, and controller for duties.'''

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''* Allow assignments to be marked for role-based reviewing.'''

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

[[File:Unchecked-Role-Based-Reviewing.png]]

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.".

[[File:Checked-Role-Based-Reviewing-no-roles.png]]

If there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

[[File:Display-duties.png]]

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

When clicked the user is directed to the new duty view:

[[File:New-Duty.png]]

Selecting back or create link back to the original assignment and upon successful creation there is a notification stating "Role was successfully created.".

[[File:Duty-creation-success.png]]

'''* Certain users can add and edit roles for assignments.'''

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

===Testing===

====RSPEC====

====UI====

===Scope for Future Improvement===

----

1. If a duty's maximum member limit is changed to be below the current number of students who are assigned to that duty nothing happens. We feel that a good future improvement would be to notify the students of the change and require them to select which students are dropped from the duty.

2. We believe that the checkbox for role-based reviewing can be moved to the general tab and only be displayed when the assignment is team based. This is due to dole-based reviewing being only available when an assignment is team based.

3. We believe that a possible future improvement would be to allow a user to import duties and their corresponding rubrics into other assignments.

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T18:47:55Z

Krschulz: Added photos to the role based reviewing section

File:Display-duties.png

2021-10-20T18:46:42Z

Krschulz: Display of duties on the assignment.

Display of duties on the assignment.

File:Duty-creation-success.png

2021-10-20T18:45:22Z

Krschulz: Duty was successfully created.

Duty was successfully created.

File:New-Duty.png

2021-10-20T18:42:40Z

Krschulz: New duty view.

New duty view.

File:Checked-Role-Based-Reviewing-no-roles.png

2021-10-20T18:40:00Z

Krschulz: Role-based checkbox has been checked and there are no roles assigned to the assignment.

Role-based checkbox has been checked and there are no roles assigned to the assignment.

File:Unchecked-Role-Based-Reviewing.png

2021-10-20T18:37:08Z

Krschulz: Role-based reviewing checkbox while unchecked on the review strategy tab

Role-based reviewing checkbox while unchecked on the review strategy tab

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T15:19:45Z

Krschulz: Second solution added, will add photos later

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

===Problem Statement===

In various agile methodologies, such as Scrum, different team members take on different roles, such as architect, facilitator, and implementer. One might want to use a different rubric for evaluating the contribution of members with different roles. Thus, this would not be separate from teammate review, but it would be a specialization of teammate review.

The following tasks were accomplished in this project:

* Created a new database table, model, view, and controller for duties.
* Allow assignments to be marked for role-based reviewing.
* Certain users can add and edit roles for assignments.

Due to naming issues all of the backend components for role-based reviewing are known as duty or duties. When referring to the backend this documentation will refer to them as duty or duties and when referring to frontend components they will be called role or roles.

===About Current Reviewing===

===Solutions Implemented and Delivered===

'''* Created a new database table, model, view, and controller for duties.'''

''Database''

We created a new duty table using scaffolding. In the database, each duty entry has an assignment_id, a max_duty_limit, and a duty_name.

* The assignment_id is the id of the assignment to which this duty belongs to.
* The max_duty_limit field is an integer and is the maximum number of students who are allowed to have a specific duty (e.g. 1 scrum master but 5 developers are allowed).
* The duty_name is the name of the duty and will be displayed as Role name on the frontend.

''Model''

The model for duty is simple and simply marks a duty as belonging to assignment:

<pre>
class Duty < ActiveRecord::Base
belongs_to :assignment
end
</pre>

''Views''

There were quite a few new views added for the implementation, they will simply be mentioned in this section and then explained in the corresponding solution description.

The new views were:

* actions
* add_duties
* add_duty
* checkbox
* duty
* table_header
* table_line
* edit
* new

''Controller''

We created a new duties controller which allows for creation, editing, and deletion of duties from an assignment. The controller has a check to see if the current user is authorized to make the request.

'''* Allow assignments to be marked for role-based reviewing.'''

Under the Review Strategy Tab of an assignment a checkbox was added that when clicked marks the assignment as role-based reviewing and displays an interface for adding, editing, and deleting roles.

In the Review Strategy Tab under the self review checkbox we added a render call to the checkbox view:

<pre>
<% if current_page?(action: 'edit') %>

<tr>
<td id='is_duty_based_assignment'>
<input name="assignment_form[assignment][is_duty_based_assignment]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][is_duty_based_assignment]', 'true', @assignment_form.assignment.is_duty_based_assignment, {:id => "is_duty_checkbox", :onChange => 'hasDutiesChanged()'}) %>
<%= label_tag('duty_assignment', 'Is Role-Based Reviewing?') %>
<img src="/assets/info.png" title='Check the box if this assignment allows role assignments within the team'>

<div id="add_duties" <%= "hidden" if not @assignment_form.assignment.is_duty_based_assignment %> >
<br>

<%= render '/duties/add_duties' %>
</div>
</td>
</tr>
<% end %>
</pre>

The checkbox view checks if the current page is being edited rather than created since duties rely on an assignment existing to link via id. This functionality is similar to how topics are added to the assignment.

If the checkbox is checked and saved the assignment will be marked as a role-based reviewing assignment via the database column is_duty_based_assignment in the assignment table. When the checkbox is checked the add_duties view is rendered and displayed as well. When unchecked the view is hidden and the is_duty_based_assignment is marked as false when saved.

If the assignment has no duties in the backend the add_duties view will display a note with the text "Roles have not yet been created.", if there are duties linked to the currently edited assignment then the view will render a table header from the table_header view and a line for each duty from the table_line view. At the end of this view, the add_duty partial view is rendered.

The table_header view displays a table header with three items. Role name, Maximum member limit, and Actions, each with respective widths of 45%, 45%, and 10%.

The table_line view crafts a table row based on the duty that was passed to it. The first column is the duty's duty_name with a link to the editing page for the duty if clicked. The next column is the duty's max_duty_limit, and the final column is a list of actions for the current duty which is rendered using the actions view.

The actions view displays two linked images, these are named "Edit Role" and "Delete Role", and are linked to their respective actions. The icons used for these actions are in line with other parts of expertiza for the actions that they represent.

The add_duty view is a link to the new view and is labelled "New role".

'''* Certain users can add and edit roles for assignments.'''

Users with TA privileges are able to add a role (added as duty to backend for clarity) to an assignment.

===Testing===

====RSPEC====

====UI====

===Scope for Future Improvement===

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T14:59:19Z

Krschulz: Added first solution to documentation, saving so progress is not lost

CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing

2021-10-20T14:14:28Z

Krschulz: Added documentation skeleton

==E2147. Role-based reviewing==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

===Problem Statement===

===About Current Reviewing===

===Solutions Implemented and Delivered===

===Testing===

====RSPEC====

====UI====

===Scope for Future Improvement===

CSC/ECE 517 Fall 2021

2021-10-20T14:05:22Z

Krschulz: /* OSS Projects */

== OSS Projects ==
* [[CSC/ECE 517 Fall 2021 - {$num}. {$desc.title}]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]
* [[CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing]]