https://wiki.expertiza.ncsu.edu/api.php?action=feedcontributions&feedformat=atom&user=NwenExpertiza_Wiki - User contributions [en]2026-05-14T17:39:52ZUser contributionsMediaWiki 1.41.0https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114559CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T21:02:04Z<p>Nwen: /* What did we implement */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
2. We created a migration file "_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment <br />
<br />
[[File:Capture1.GIF]]<br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first <br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
[[File:Capture3.GIF]]<br />
<br />
7. We changed the view for student review list in "app/views/student_review/list.html.erb" file.<br />
<br />
[[File:Capture2.GIF]]<br />
<br />
== Tests ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'datetimepicker_calibration_review', with: (Time.now.in_time_zone + 10.days).strftime("%Y/%m/%d %H:%M")<br />
click_button 'submit_btn'<br />
calibration_type_id = DeadlineType.where(name: 'calibration_review')[0].id<br />
calibration_due_date = DueDate.find(12)<br />
expect(calibration_due_date).to have_attributes(<br />
deadline_type_id: calibration_type_id,<br />
type: 'AssignmentDueDate'<br />
)<br />
end<br />
end<br />
end<br />
end<br />
<br />
2. When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
* Since the test contained duplicate code, we load the code in load_work method and set the stage of the current assignment as "calibration" state so the review contains Calibration Review 1, 2, 3 and student can view their calibration result when clicking on View link.<br />
<br />
context 'when current assignment is in calibration stage' do<br />
context 'calibration feature' do<br />
it 'works correctly' do<br />
load_work(DateTime.now.in_time_zone + 10, DateTime.now.in_time_zone + 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "calibration")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("View")<br />
click_link "View"<br />
end<br />
end<br />
end<br />
<br />
<br />
3. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
* When the project is in review stage, the number of review allowance will not affect by the number of calibration review numbers, so we check the number of review allow is still the same after changing the stage to review stage and the page should contains Calibration Review 1 and Review 1.<br />
<br />
context 'when current assignment is in review stage' do<br />
it 'excludes calibration reviews from outstanding review restriction and total review restriction' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Number of reviews allowed: 3")<br />
end<br />
it 'shows \'Review 1, 2, 3...\' and \'Calibration review 1, 2, 3...\' on student_review#list page' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("Review 1")<br />
end<br />
end<br />
end<br />
<br />
== Files Modified ==<br />
* app/controllers/student_review_controller.rb<br />
* app/models/deadline_right.rb<br />
* app/models/due_date.rb<br />
* app/views/assignments/edit/_due_dates.html.erb<br />
* app/views/student_review/_responses.html.erb<br />
* app/views/student_review/list.html.erb<br />
* New created file: spec/features/calibration_spec.rb<br />
* New created file: 20171206202730_add_calibration_review_to_deadline_types.rb</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114558CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T21:01:37Z<p>Nwen: /* What did we implement */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
2. We created a migration file "_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment <br />
<br />
[[File:Capture1.GIF]]<br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first <br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
[[File:Capture2.GIF]]<br />
<br />
7. We changed the view for student review list in "app/views/student_review/list.html.erb" file.<br />
<br />
[[File:Capture3.GIF]]<br />
<br />
== Tests ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'datetimepicker_calibration_review', with: (Time.now.in_time_zone + 10.days).strftime("%Y/%m/%d %H:%M")<br />
click_button 'submit_btn'<br />
calibration_type_id = DeadlineType.where(name: 'calibration_review')[0].id<br />
calibration_due_date = DueDate.find(12)<br />
expect(calibration_due_date).to have_attributes(<br />
deadline_type_id: calibration_type_id,<br />
type: 'AssignmentDueDate'<br />
)<br />
end<br />
end<br />
end<br />
end<br />
<br />
2. When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
* Since the test contained duplicate code, we load the code in load_work method and set the stage of the current assignment as "calibration" state so the review contains Calibration Review 1, 2, 3 and student can view their calibration result when clicking on View link.<br />
<br />
context 'when current assignment is in calibration stage' do<br />
context 'calibration feature' do<br />
it 'works correctly' do<br />
load_work(DateTime.now.in_time_zone + 10, DateTime.now.in_time_zone + 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "calibration")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("View")<br />
click_link "View"<br />
end<br />
end<br />
end<br />
<br />
<br />
3. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
* When the project is in review stage, the number of review allowance will not affect by the number of calibration review numbers, so we check the number of review allow is still the same after changing the stage to review stage and the page should contains Calibration Review 1 and Review 1.<br />
<br />
context 'when current assignment is in review stage' do<br />
it 'excludes calibration reviews from outstanding review restriction and total review restriction' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Number of reviews allowed: 3")<br />
end<br />
it 'shows \'Review 1, 2, 3...\' and \'Calibration review 1, 2, 3...\' on student_review#list page' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("Review 1")<br />
end<br />
end<br />
end<br />
<br />
== Files Modified ==<br />
* app/controllers/student_review_controller.rb<br />
* app/models/deadline_right.rb<br />
* app/models/due_date.rb<br />
* app/views/assignments/edit/_due_dates.html.erb<br />
* app/views/student_review/_responses.html.erb<br />
* app/views/student_review/list.html.erb<br />
* New created file: spec/features/calibration_spec.rb<br />
* New created file: 20171206202730_add_calibration_review_to_deadline_types.rb</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114553CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T20:58:57Z<p>Nwen: /* What did we implement */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
2. We created a migration file "_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment <br />
<br />
[[File:Capture1.GIF]]<br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first <br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
[[File:Capture2.GIF]]<br />
<br />
7. We changed the view for student review list in "app/views/student_review/list.html.erb" file.<br />
<br />
[[File:Capture1.GIF]]<br />
<br />
== Tests ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'datetimepicker_calibration_review', with: (Time.now.in_time_zone + 10.days).strftime("%Y/%m/%d %H:%M")<br />
click_button 'submit_btn'<br />
calibration_type_id = DeadlineType.where(name: 'calibration_review')[0].id<br />
calibration_due_date = DueDate.find(12)<br />
expect(calibration_due_date).to have_attributes(<br />
deadline_type_id: calibration_type_id,<br />
type: 'AssignmentDueDate'<br />
)<br />
end<br />
end<br />
end<br />
end<br />
<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
* Since the test contained duplicate code, we load the code in load_work method and set the stage of the current assignment as "calibration" state so the review contains Calibration Review 1, 2, 3 and student can view their calibration result when clicking on View link.<br />
<br />
context 'when current assignment is in calibration stage' do<br />
context 'calibration feature' do<br />
it 'works correctly' do<br />
load_work(DateTime.now.in_time_zone + 10, DateTime.now.in_time_zone + 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "calibration")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("View")<br />
click_link "View"<br />
end<br />
end<br />
end<br />
<br />
<br />
3. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
* When the project is in review stage, the number of review allowance will not affect by the number of calibration review numbers, so we check the number of review allow is still the same after changing the stage to review stage and the page should contains Calibration Review 1 and Review 1.<br />
<br />
context 'when current assignment is in review stage' do<br />
it 'excludes calibration reviews from outstanding review restriction and total review restriction' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Number of reviews allowed: 3")<br />
end<br />
it 'shows \'Review 1, 2, 3...\' and \'Calibration review 1, 2, 3...\' on student_review#list page' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("Review 1")<br />
end<br />
end<br />
end<br />
<br />
8. Files modified<br />
* app/controllers/student_review_controller.rb<br />
* app/models/deadline_right.rb<br />
* app/models/due_date.rb<br />
* app/views/assignments/edit/_due_dates.html.erb<br />
* app/views/student_review/_responses.html.erb<br />
* app/views/student_review/list.html.erb<br />
* New created file: spec/features/calibration_spec.rb<br />
* New created file: 20171206202730_add_calibration_review_to_deadline_types.rb</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114551CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T20:58:29Z<p>Nwen: /* What did we implement */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
2. We created a migration file "_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment <br />
[[File:Capture1.GIF]]<br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first <br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
[[File:Capture2.GIF]]<br />
<br />
7. We changed the view for student review list in "app/views/student_review/list.html.erb" file.<br />
[[File:Capture1.GIF]]<br />
<br />
== Tests ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'datetimepicker_calibration_review', with: (Time.now.in_time_zone + 10.days).strftime("%Y/%m/%d %H:%M")<br />
click_button 'submit_btn'<br />
calibration_type_id = DeadlineType.where(name: 'calibration_review')[0].id<br />
calibration_due_date = DueDate.find(12)<br />
expect(calibration_due_date).to have_attributes(<br />
deadline_type_id: calibration_type_id,<br />
type: 'AssignmentDueDate'<br />
)<br />
end<br />
end<br />
end<br />
end<br />
<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
* Since the test contained duplicate code, we load the code in load_work method and set the stage of the current assignment as "calibration" state so the review contains Calibration Review 1, 2, 3 and student can view their calibration result when clicking on View link.<br />
<br />
context 'when current assignment is in calibration stage' do<br />
context 'calibration feature' do<br />
it 'works correctly' do<br />
load_work(DateTime.now.in_time_zone + 10, DateTime.now.in_time_zone + 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "calibration")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("View")<br />
click_link "View"<br />
end<br />
end<br />
end<br />
<br />
<br />
3. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
* When the project is in review stage, the number of review allowance will not affect by the number of calibration review numbers, so we check the number of review allow is still the same after changing the stage to review stage and the page should contains Calibration Review 1 and Review 1.<br />
<br />
context 'when current assignment is in review stage' do<br />
it 'excludes calibration reviews from outstanding review restriction and total review restriction' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Number of reviews allowed: 3")<br />
end<br />
it 'shows \'Review 1, 2, 3...\' and \'Calibration review 1, 2, 3...\' on student_review#list page' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("Review 1")<br />
end<br />
end<br />
end</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Capture3.GIF&diff=114550File:Capture3.GIF2017-12-06T20:56:28Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Capture2.GIF&diff=114549File:Capture2.GIF2017-12-06T20:56:21Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Capture1.GIF&diff=114548File:Capture1.GIF2017-12-06T20:56:13Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114547CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T20:54:32Z<p>Nwen: /* What did we implement */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
<br />
2. We created a migration file "_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
class AddNewDeadlineType < ActiveRecord::Migration<br />
def self.up<br />
execute "INSERT INTO `deadline_types` VALUES (12,'calibration_review');"<br />
end<br />
def self.down<br />
execute "DELETE FROM `deadline_types` WHERE `name` = 'calibration_review';"<br />
end<br />
end<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment (Modified file: app/views/assignments/edit/_due_dates.html.erb)<br />
<% if @assignment_form.assignment.is_calibrated %><br />
addDueDateTableElement(<%= @due_date_nameurl_notempty==nil ? false:@due_date_nameurl_notempty %>,'calibration', <br />
0, <%= due_date(@assignment_form.assignment, 'calibration_review').to_json.html_safe %>);<br />
<%end %><br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
'calibration_review' => {<br />
'submission_allowed' => NO,<br />
'can_review' => OK,<br />
'review_of_review_allowed' => NO<br />
}<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first (Modified file: app/models/due_date.rb)<br />
next_due_date = AssignmentDueDate.where(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now]).order('due_at').first<br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
@regular_review_mappings = []<br />
@calibration_review_mappings = []<br />
@participant = AssignmentParticipant.find(params[:id])<br />
return unless current_user_id?(@participant.user_id)<br />
@assignment = @participant.assignment<br />
# Find the current phase that the assignment is in.<br />
@topic_id = SignedUpTeam.topic_id(@participant.parent_id, @participant.user_id)<br />
@review_phase = @assignment.get_current_stage(@topic_id)<br />
# ACS Removed the if condition(and corressponding else) which differentiate assignments as team and individual assignments<br />
# to treat all assignments as team assignments<br />
@review_mappings = ReviewResponseMap.where(reviewer_id: @participant.id) <br />
# if it is an calibrated assignment, change the response_map order in a certain way<br />
@review_mappings = @review_mappings.sort_by {|mapping| mapping.id % 5} if @assignment.is_calibrated == true<br />
@metareview_mappings = MetareviewResponseMap.where(reviewer_id: @participant.id) <br />
# Calculate the number of reviews that the user has completed so far.<br />
@calibration_deadline = @assignment.due_dates.find_by_deadline_type_id(12)<br />
@num_reviews_total = @review_mappings.size <br />
# Add the reviews which are requested and not began.<br />
@num_regular_reviews_completed = 0<br />
@num_calibration_reviews_completed = 0<br />
@num_regular_reviews_total = 0<br />
@num_calibration_reviews_total = 0<br />
assignment_submission_due_date = @assignment.due_dates.select {|due_date| due_date.deadline_type_id == 1}.first.due_at<br />
@review_mappings.each do |map|<br />
next if map.response.empty?<br />
if map.response.last.updated_at < assignment_submission_due_date<br />
@num_calibration_reviews_completed += 1 if map.response.last.is_submitted<br />
else<br />
# @regular_review_mappings.push(map)<br />
@num_regular_reviews_completed += 1 if map.response.last.is_submitted<br />
end<br />
end<br />
@review_mappings.each do |map|<br />
if map.updated_at < assignment_submission_due_date<br />
@calibration_review_mappings.push(map)<br />
@num_calibration_reviews_total += 1<br />
else<br />
@regular_review_mappings.push(map)<br />
@num_regular_reviews_total += 1<br />
end<br />
end<br />
@num_calibration_reviews_in_progress = @num_calibration_reviews_total - @num_calibration_reviews_completed<br />
@num_regular_reviews_in_progress = @num_regular_reviews_total - @num_regular_reviews_completed<br />
# Calculate the number of metareviews that the user has completed so far.<br />
@num_metareviews_total = @metareview_mappings.size<br />
@num_metareviews_completed = 0<br />
@metareview_mappings.each do |map|<br />
@num_metareviews_completed += 1 unless map.response.empty?<br />
end<br />
@num_metareviews_in_progress = @num_metareviews_total - @num_metareviews_completed<br />
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)<br />
<br />
7. We changed the view for student review list in "app/views/student_review/list.html.erb" file.<br />
<br />
If the current stage is "Calibration Review"<br />
<br />
<% if check_reviewable_topics(@assignment) or @assignment.get_current_stage(@topic_id) == "Finished" %><br />
<%= render :partial => 'responses', :locals => {:mappings => @calibration_review_mappings, :title => 'Calibration Review'} %><br />
<% if @assignment.dynamic_reviewer_assignment? %><br />
<% if @num_calibration_reviews_in_progress >= Assignment.max_outstanding_reviews %><br />
<br><br><br />
<span>Note: You can't have more than 2 calibration reviews. You must complete one of your calibration reviews before selecting another.</span><br />
<% elsif @assignment.num_reviews && @assignment.num_reviews >= 0 && @num_calibration_reviews_total > @assignment.num_reviews %><br />
<br><br><br />
<span>Note: You can't do more than <%= @assignment.num_reviews %><br />
reviews according to assignment policy.</span><br />
<% else %><br />
<%= render :partial => 'set_dynamic_review', :locals => {:assignment => @assignment, :participant => @participant} %><br />
<% end %><br />
<% end %><br />
<% else %><br />
<em>Reviews cannot be performed at this time</em><br />
<% end %><br />
<br />
If the current stage is "Review"<br />
<% if @assignment.get_current_stage(@topic_id) == "review" %><br />
<% if check_reviewable_topics(@assignment) or @assignment.get_current_stage(@topic_id) == "Finished" %><br />
<%= render :partial => 'responses', :locals => {:mappings => @regular_review_mappings, :title => 'Review'} %><br />
<% if @assignment.dynamic_reviewer_assignment? %><br />
<% if @num_reviews_in_progress >= Assignment.max_outstanding_reviews %><br />
<br><br><br />
<span>Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another.</span><br />
<% elsif @assignment.num_reviews && @assignment.num_reviews >= 0 && @num_reviews_total > @assignment.num_reviews %><br />
<br><br><br />
<span>Note: You can't do more than <%= @assignment.num_reviews %> reviews according to assignment policy.</span><br />
<% else %><br />
<%= render :partial => 'set_dynamic_review', :locals => {:assignment => @assignment, :participant => @participant} %><br />
<% end %><br />
<% else %><br />
<em>Reviews cannot be performed at this time</em><br />
<% end %><br />
<% end %><br />
<% end %><br />
<br />
== Tests ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'datetimepicker_calibration_review', with: (Time.now.in_time_zone + 10.days).strftime("%Y/%m/%d %H:%M")<br />
click_button 'submit_btn'<br />
calibration_type_id = DeadlineType.where(name: 'calibration_review')[0].id<br />
calibration_due_date = DueDate.find(12)<br />
expect(calibration_due_date).to have_attributes(<br />
deadline_type_id: calibration_type_id,<br />
type: 'AssignmentDueDate'<br />
)<br />
end<br />
end<br />
end<br />
end<br />
<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
* Since the test contained duplicate code, we load the code in load_work method and set the stage of the current assignment as "calibration" state so the review contains Calibration Review 1, 2, 3 and student can view their calibration result when clicking on View link.<br />
<br />
context 'when current assignment is in calibration stage' do<br />
context 'calibration feature' do<br />
it 'works correctly' do<br />
load_work(DateTime.now.in_time_zone + 10, DateTime.now.in_time_zone + 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "calibration")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("View")<br />
click_link "View"<br />
end<br />
end<br />
end<br />
<br />
<br />
3. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
* When the project is in review stage, the number of review allowance will not affect by the number of calibration review numbers, so we check the number of review allow is still the same after changing the stage to review stage and the page should contains Calibration Review 1 and Review 1.<br />
<br />
context 'when current assignment is in review stage' do<br />
it 'excludes calibration reviews from outstanding review restriction and total review restriction' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Number of reviews allowed: 3")<br />
end<br />
it 'shows \'Review 1, 2, 3...\' and \'Calibration review 1, 2, 3...\' on student_review#list page' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("Review 1")<br />
end<br />
end<br />
end</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114540CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T18:52:57Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
<br />
2. We created a migration file "222222222222222_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
class AddNewDeadlineType < ActiveRecord::Migration<br />
def self.up<br />
execute "INSERT INTO `deadline_types` VALUES (12,'calibration_review');"<br />
end<br />
def self.down<br />
execute "DELETE FROM `deadline_types` WHERE `name` = 'calibration_review';"<br />
end<br />
end<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment (Modified file: app/views/assignments/edit/_due_dates.html.erb)<br />
<% if @assignment_form.assignment.is_calibrated %><br />
addDueDateTableElement(<%= @due_date_nameurl_notempty==nil ? false:@due_date_nameurl_notempty %>,'calibration', <br />
0, <%= due_date(@assignment_form.assignment, 'calibration_review').to_json.html_safe %>);<br />
<%end %><br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
'calibration_review' => {<br />
'submission_allowed' => NO,<br />
'can_review' => OK,<br />
'review_of_review_allowed' => NO<br />
}<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first (Modified file: app/models/due_date.rb)<br />
next_due_date = AssignmentDueDate.where(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now]).order('due_at').first<br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
@regular_review_mappings = []<br />
@calibration_review_mappings = []<br />
@participant = AssignmentParticipant.find(params[:id])<br />
return unless current_user_id?(@participant.user_id)<br />
@assignment = @participant.assignment<br />
# Find the current phase that the assignment is in.<br />
@topic_id = SignedUpTeam.topic_id(@participant.parent_id, @participant.user_id)<br />
@review_phase = @assignment.get_current_stage(@topic_id)<br />
# ACS Removed the if condition(and corressponding else) which differentiate assignments as team and individual assignments<br />
# to treat all assignments as team assignments<br />
@review_mappings = ReviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# if it is an calibrated assignment, change the response_map order in a certain way<br />
@review_mappings = @review_mappings.sort_by {|mapping| mapping.id % 5} if @assignment.is_calibrated == true<br />
@metareview_mappings = MetareviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# Calculate the number of reviews that the user has completed so far.<br />
@calibration_deadline = @assignment.due_dates.find_by_deadline_type_id(12)<br />
@num_reviews_total = @review_mappings.size<br />
<br />
# Add the reviews which are requested and not began.<br />
@num_regular_reviews_completed = 0<br />
@num_calibration_reviews_completed = 0<br />
@num_regular_reviews_total = 0<br />
@num_calibration_reviews_total = 0<br />
assignment_submission_due_date = @assignment.due_dates.select {|due_date| due_date.deadline_type_id == 1}.first.due_at<br />
@review_mappings.each do |map|<br />
<br />
next if map.response.empty?<br />
if map.response.last.updated_at < assignment_submission_due_date<br />
@num_calibration_reviews_completed += 1 if map.response.last.is_submitted<br />
else<br />
# @regular_review_mappings.push(map)<br />
@num_regular_reviews_completed += 1 if map.response.last.is_submitted<br />
end<br />
end<br />
@review_mappings.each do |map|<br />
if map.updated_at < assignment_submission_due_date<br />
@calibration_review_mappings.push(map)<br />
@num_calibration_reviews_total += 1<br />
else<br />
@regular_review_mappings.push(map)<br />
@num_regular_reviews_total += 1<br />
end<br />
end<br />
<br />
@num_calibration_reviews_in_progress = @num_calibration_reviews_total - @num_calibration_reviews_completed<br />
@num_regular_reviews_in_progress = @num_regular_reviews_total - @num_regular_reviews_completed<br />
<br />
# Calculate the number of metareviews that the user has completed so far.<br />
@num_metareviews_total = @metareview_mappings.size<br />
@num_metareviews_completed = 0<br />
@metareview_mappings.each do |map|<br />
@num_metareviews_completed += 1 unless map.response.empty?<br />
end<br />
@num_metareviews_in_progress = @num_metareviews_total - @num_metareviews_completed<br />
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)<br />
<br />
7. We changed the view for student review list in "app/views/student_review/list.html.erb" file.<br />
<br />
If the current stage is "Calibration Review"<br />
<br />
<% if check_reviewable_topics(@assignment) or @assignment.get_current_stage(@topic_id) == "Finished" %><br />
<%= render :partial => 'responses', :locals => {:mappings => @calibration_review_mappings, :title => 'Calibration Review'} %><br />
<% if @assignment.dynamic_reviewer_assignment? %><br />
<% if @num_calibration_reviews_in_progress >= Assignment.max_outstanding_reviews %><br />
<br><br><br />
<span>Note: You can't have more than 2 calibration reviews. You must complete one of your calibration reviews before selecting another.</span><br />
<% elsif @assignment.num_reviews && @assignment.num_reviews >= 0 && @num_calibration_reviews_total > @assignment.num_reviews %><br />
<br><br><br />
<span>Note: You can't do more than <%= @assignment.num_reviews %><br />
reviews according to assignment policy.</span><br />
<% else %><br />
<%= render :partial => 'set_dynamic_review', :locals => {:assignment => @assignment, :participant => @participant} %><br />
<% end %><br />
<% end %><br />
<% else %><br />
<p><em>Reviews cannot be performed at this time</em></p><br />
<% end %><br />
<br />
If the current stage is "Review"<br />
<% if @assignment.get_current_stage(@topic_id) == "review" %><br />
<% if check_reviewable_topics(@assignment) or @assignment.get_current_stage(@topic_id) == "Finished" %><br />
<%= render :partial => 'responses', :locals => {:mappings => @regular_review_mappings, :title => 'Review'} %><br />
<% if @assignment.dynamic_reviewer_assignment? %><br />
<% if @num_reviews_in_progress >= Assignment.max_outstanding_reviews %><br />
<br><br><br />
<span>Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another.</span><br />
<% elsif @assignment.num_reviews && @assignment.num_reviews >= 0 && @num_reviews_total > @assignment.num_reviews %><br />
<br><br><br />
<span>Note: You can't do more than <%= @assignment.num_reviews %> reviews according to assignment policy.</span><br />
<% else %><br />
<%= render :partial => 'set_dynamic_review', :locals => {:assignment => @assignment, :participant => @participant} %><br />
<% end %><br />
<% else %><br />
<p><em>Reviews cannot be performed at this time</em></p><br />
<% end %><br />
<% end %><br />
<% end %><br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'datetimepicker_calibration_review', with: (Time.now.in_time_zone + 10.days).strftime("%Y/%m/%d %H:%M")<br />
click_button 'submit_btn'<br />
calibration_type_id = DeadlineType.where(name: 'calibration_review')[0].id<br />
calibration_due_date = DueDate.find(12)<br />
expect(calibration_due_date).to have_attributes(<br />
deadline_type_id: calibration_type_id,<br />
type: 'AssignmentDueDate'<br />
)<br />
end<br />
end<br />
end<br />
end<br />
<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
* Since the test contained duplicate code, we load the code in load_work method and set the stage of the current assignment as "calibration" state so the review contains Calibration Review 1, 2, 3 and student can view their calibration result when clicking on View link.<br />
<br />
context 'when current assignment is in calibration stage' do<br />
context 'calibration feature' do<br />
it 'works correctly' do<br />
load_work(DateTime.now.in_time_zone + 10, DateTime.now.in_time_zone + 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "calibration")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("View")<br />
click_link "View"<br />
end<br />
end<br />
end<br />
<br />
<br />
3. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
* When the project is in review stage, the number of review allowance will not affect by the number of calibration review numbers, so we check the number of review allow is still the same after changing the stage to review stage and the page should contains Calibration Review 1 and Review 1.<br />
<br />
context 'when current assignment is in review stage' do<br />
it 'excludes calibration reviews from outstanding review restriction and total review restriction' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Number of reviews allowed: 3")<br />
end<br />
it 'shows \'Review 1, 2, 3...\' and \'Calibration review 1, 2, 3...\' on student_review#list page' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("Review 1")<br />
end<br />
end<br />
end</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114539CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T18:47:54Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
<br />
2. We created a migration file "222222222222222_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
class AddNewDeadlineType < ActiveRecord::Migration<br />
def self.up<br />
execute "INSERT INTO `deadline_types` VALUES (12,'calibration_review');"<br />
end<br />
def self.down<br />
execute "DELETE FROM `deadline_types` WHERE `name` = 'calibration_review';"<br />
end<br />
end<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment (Modified file: app/views/assignments/edit/_due_dates.html.erb)<br />
<% if @assignment_form.assignment.is_calibrated %><br />
addDueDateTableElement(<%= @due_date_nameurl_notempty==nil ? false:@due_date_nameurl_notempty %>,'calibration', <br />
0, <%= due_date(@assignment_form.assignment, 'calibration_review').to_json.html_safe %>);<br />
<%end %><br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
'calibration_review' => {<br />
'submission_allowed' => NO,<br />
'can_review' => OK,<br />
'review_of_review_allowed' => NO<br />
}<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first (Modified file: app/models/due_date.rb)<br />
next_due_date = AssignmentDueDate.where(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now]).order('due_at').first<br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
@regular_review_mappings = []<br />
@calibration_review_mappings = []<br />
@participant = AssignmentParticipant.find(params[:id])<br />
return unless current_user_id?(@participant.user_id)<br />
@assignment = @participant.assignment<br />
# Find the current phase that the assignment is in.<br />
@topic_id = SignedUpTeam.topic_id(@participant.parent_id, @participant.user_id)<br />
@review_phase = @assignment.get_current_stage(@topic_id)<br />
# ACS Removed the if condition(and corressponding else) which differentiate assignments as team and individual assignments<br />
# to treat all assignments as team assignments<br />
@review_mappings = ReviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# if it is an calibrated assignment, change the response_map order in a certain way<br />
@review_mappings = @review_mappings.sort_by {|mapping| mapping.id % 5} if @assignment.is_calibrated == true<br />
@metareview_mappings = MetareviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# Calculate the number of reviews that the user has completed so far.<br />
@calibration_deadline = @assignment.due_dates.find_by_deadline_type_id(12)<br />
@num_reviews_total = @review_mappings.size<br />
<br />
# Add the reviews which are requested and not began.<br />
@num_regular_reviews_completed = 0<br />
@num_calibration_reviews_completed = 0<br />
@num_regular_reviews_total = 0<br />
@num_calibration_reviews_total = 0<br />
assignment_submission_due_date = @assignment.due_dates.select {|due_date| due_date.deadline_type_id == 1}.first.due_at<br />
@review_mappings.each do |map|<br />
<br />
next if map.response.empty?<br />
if map.response.last.updated_at < assignment_submission_due_date<br />
@num_calibration_reviews_completed += 1 if map.response.last.is_submitted<br />
else<br />
# @regular_review_mappings.push(map)<br />
@num_regular_reviews_completed += 1 if map.response.last.is_submitted<br />
end<br />
end<br />
@review_mappings.each do |map|<br />
if map.updated_at < assignment_submission_due_date<br />
@calibration_review_mappings.push(map)<br />
@num_calibration_reviews_total += 1<br />
else<br />
@regular_review_mappings.push(map)<br />
@num_regular_reviews_total += 1<br />
end<br />
end<br />
<br />
@num_calibration_reviews_in_progress = @num_calibration_reviews_total - @num_calibration_reviews_completed<br />
@num_regular_reviews_in_progress = @num_regular_reviews_total - @num_regular_reviews_completed<br />
<br />
# Calculate the number of metareviews that the user has completed so far.<br />
@num_metareviews_total = @metareview_mappings.size<br />
@num_metareviews_completed = 0<br />
@metareview_mappings.each do |map|<br />
@num_metareviews_completed += 1 unless map.response.empty?<br />
end<br />
@num_metareviews_in_progress = @num_metareviews_total - @num_metareviews_completed<br />
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)<br />
<br />
7. We changed the view for student review list in "app/views/student_review/list.html.erb" file.<br />
<br />
If the current stage is "Calibration Review"<br />
<br />
<% if check_reviewable_topics(@assignment) or @assignment.get_current_stage(@topic_id) == "Finished" %><br />
<%= render :partial => 'responses', :locals => {:mappings => @calibration_review_mappings, :title => 'Calibration Review'} %><br />
<% if @assignment.dynamic_reviewer_assignment? %><br />
<% if @num_calibration_reviews_in_progress >= Assignment.max_outstanding_reviews %><br />
<br><br><br />
<span>Note: You can't have more than 2 calibration reviews. You must complete one of your calibration reviews before selecting another.</span><br />
<% elsif @assignment.num_reviews && @assignment.num_reviews >= 0 && @num_calibration_reviews_total > @assignment.num_reviews %><br />
<br><br><br />
<span>Note: You can't do more than <%= @assignment.num_reviews %><br />
reviews according to assignment policy.</span><br />
<% else %><br />
<%= render :partial => 'set_dynamic_review', :locals => {:assignment => @assignment, :participant => @participant} %><br />
<% end %><br />
<% end %><br />
<% else %><br />
<p><em>Reviews cannot be performed at this time</em></p><br />
<% end %><br />
<br />
If the current stage is "Review"<br />
<% if @assignment.get_current_stage(@topic_id) == "review" %><br />
<% if check_reviewable_topics(@assignment) or @assignment.get_current_stage(@topic_id) == "Finished" %><br />
<%= render :partial => 'responses', :locals => {:mappings => @regular_review_mappings, :title => 'Review'} %><br />
<% if @assignment.dynamic_reviewer_assignment? %><br />
<% if @num_reviews_in_progress >= Assignment.max_outstanding_reviews %><br />
<br><br><br />
<span>Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another.</span><br />
<% elsif @assignment.num_reviews && @assignment.num_reviews >= 0 && @num_reviews_total > @assignment.num_reviews %><br />
<br><br><br />
<span>Note: You can't do more than <%= @assignment.num_reviews %> reviews according to assignment policy.</span><br />
<% else %><br />
<%= render :partial => 'set_dynamic_review', :locals => {:assignment => @assignment, :participant => @participant} %><br />
<% end %><br />
<% else %><br />
<p><em>Reviews cannot be performed at this time</em></p><br />
<% end %><br />
<% end %><br />
<% end %><br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'calibration', with: 'Date'<br />
click_button 'Save'<br />
end<br />
end<br />
end<br />
end<br />
<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
* Since the test contained duplicate code, we load the code in load_work method and set the stage of the current assignment as "calibration" state so the review contains Calibration Review 1, 2, 3 and student can view their calibration result when clicking on View link.<br />
<br />
context 'when current assignment is in calibration stage' do<br />
context 'calibration feature' do<br />
it 'works correctly' do<br />
load_work(DateTime.now.in_time_zone + 10, DateTime.now.in_time_zone + 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "calibration")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("View")<br />
click_link "View"<br />
end<br />
end<br />
end<br />
<br />
<br />
3. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
* When the project is in review stage, the number of review allowance will not affect by the number of calibration review numbers, so we check the number of review allow is still the same after changing the stage to review stage and the page should contains Calibration Review 1 and Review 1.<br />
<br />
context 'when current assignment is in review stage' do<br />
it 'excludes calibration reviews from outstanding review restriction and total review restriction' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Number of reviews allowed: 3")<br />
end<br />
it 'shows \'Review 1, 2, 3...\' and \'Calibration review 1, 2, 3...\' on student_review#list page' do<br />
load_work(DateTime.now.in_time_zone - 10, DateTime.now.in_time_zone - 20, DateTime.now.in_time_zone + 30,<br />
DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, DateTime.now.in_time_zone + 20,<br />
DateTime.now.in_time_zone + 30, DateTime.now.in_time_zone + 40, DateTime.now.in_time_zone + 50, "review")<br />
expect(page).to have_content("Calibration Review 1")<br />
expect(page).to have_content("Review 1")<br />
end<br />
end<br />
end</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114533CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T18:41:01Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
<br />
2. We created a migration file "222222222222222_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
class AddNewDeadlineType < ActiveRecord::Migration<br />
def self.up<br />
execute "INSERT INTO `deadline_types` VALUES (12,'calibration_review');"<br />
end<br />
def self.down<br />
execute "DELETE FROM `deadline_types` WHERE `name` = 'calibration_review';"<br />
end<br />
end<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment (Modified file: app/views/assignments/edit/_due_dates.html.erb)<br />
<% if @assignment_form.assignment.is_calibrated %><br />
addDueDateTableElement(<%= @due_date_nameurl_notempty==nil ? false:@due_date_nameurl_notempty %>,'calibration', <br />
0, <%= due_date(@assignment_form.assignment, 'calibration_review').to_json.html_safe %>);<br />
<%end %><br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
'calibration_review' => {<br />
'submission_allowed' => NO,<br />
'can_review' => OK,<br />
'review_of_review_allowed' => NO<br />
}<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first (Modified file: app/models/due_date.rb)<br />
next_due_date = AssignmentDueDate.where(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now]).order('due_at').first<br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
@regular_review_mappings = []<br />
@calibration_review_mappings = []<br />
@participant = AssignmentParticipant.find(params[:id])<br />
return unless current_user_id?(@participant.user_id)<br />
@assignment = @participant.assignment<br />
# Find the current phase that the assignment is in.<br />
@topic_id = SignedUpTeam.topic_id(@participant.parent_id, @participant.user_id)<br />
@review_phase = @assignment.get_current_stage(@topic_id)<br />
# ACS Removed the if condition(and corressponding else) which differentiate assignments as team and individual assignments<br />
# to treat all assignments as team assignments<br />
@review_mappings = ReviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# if it is an calibrated assignment, change the response_map order in a certain way<br />
@review_mappings = @review_mappings.sort_by {|mapping| mapping.id % 5} if @assignment.is_calibrated == true<br />
@metareview_mappings = MetareviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# Calculate the number of reviews that the user has completed so far.<br />
@calibration_deadline = @assignment.due_dates.find_by_deadline_type_id(12)<br />
@num_reviews_total = @review_mappings.size<br />
<br />
# Add the reviews which are requested and not began.<br />
@num_regular_reviews_completed = 0<br />
@num_calibration_reviews_completed = 0<br />
@num_regular_reviews_total = 0<br />
@num_calibration_reviews_total = 0<br />
assignment_submission_due_date = @assignment.due_dates.select {|due_date| due_date.deadline_type_id == 1}.first.due_at<br />
@review_mappings.each do |map|<br />
<br />
next if map.response.empty?<br />
if map.response.last.updated_at < assignment_submission_due_date<br />
@num_calibration_reviews_completed += 1 if map.response.last.is_submitted<br />
else<br />
# @regular_review_mappings.push(map)<br />
@num_regular_reviews_completed += 1 if map.response.last.is_submitted<br />
end<br />
end<br />
@review_mappings.each do |map|<br />
if map.updated_at < assignment_submission_due_date<br />
@calibration_review_mappings.push(map)<br />
@num_calibration_reviews_total += 1<br />
else<br />
@regular_review_mappings.push(map)<br />
@num_regular_reviews_total += 1<br />
end<br />
end<br />
<br />
@num_calibration_reviews_in_progress = @num_calibration_reviews_total - @num_calibration_reviews_completed<br />
@num_regular_reviews_in_progress = @num_regular_reviews_total - @num_regular_reviews_completed<br />
<br />
# Calculate the number of metareviews that the user has completed so far.<br />
@num_metareviews_total = @metareview_mappings.size<br />
@num_metareviews_completed = 0<br />
@metareview_mappings.each do |map|<br />
@num_metareviews_completed += 1 unless map.response.empty?<br />
end<br />
@num_metareviews_in_progress = @num_metareviews_total - @num_metareviews_completed<br />
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)<br />
<br />
7.<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
* This feature test check for when Calibration for training? is selected, the value of assignment is calibrated is set to be true so the calibration tab will show up on the top of the page to fill in the due dates for the calibration period.<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'calibration', with: 'Date'<br />
click_button 'Save'<br />
end<br />
end<br />
end<br />
end<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114531CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T18:38:49Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
<br />
2. We created a migration file "222222222222222_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
class AddNewDeadlineType < ActiveRecord::Migration<br />
def self.up<br />
execute "INSERT INTO `deadline_types` VALUES (12,'calibration_review');"<br />
end<br />
def self.down<br />
execute "DELETE FROM `deadline_types` WHERE `name` = 'calibration_review';"<br />
end<br />
end<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment (Modified file: app/views/assignments/edit/_due_dates.html.erb)<br />
<% if @assignment_form.assignment.is_calibrated %><br />
addDueDateTableElement(<%= @due_date_nameurl_notempty==nil ? false:@due_date_nameurl_notempty %>,'calibration', <br />
0, <%= due_date(@assignment_form.assignment, 'calibration_review').to_json.html_safe %>);<br />
<%end %><br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
'calibration_review' => {<br />
'submission_allowed' => NO,<br />
'can_review' => OK,<br />
'review_of_review_allowed' => NO<br />
}<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first (Modified file: app/models/due_date.rb)<br />
next_due_date = AssignmentDueDate.where(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now]).order('due_at').first<br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
@regular_review_mappings = []<br />
@calibration_review_mappings = []<br />
@participant = AssignmentParticipant.find(params[:id])<br />
return unless current_user_id?(@participant.user_id)<br />
@assignment = @participant.assignment<br />
# Find the current phase that the assignment is in.<br />
@topic_id = SignedUpTeam.topic_id(@participant.parent_id, @participant.user_id)<br />
@review_phase = @assignment.get_current_stage(@topic_id)<br />
# ACS Removed the if condition(and corressponding else) which differentiate assignments as team and individual assignments<br />
# to treat all assignments as team assignments<br />
@review_mappings = ReviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# if it is an calibrated assignment, change the response_map order in a certain way<br />
@review_mappings = @review_mappings.sort_by {|mapping| mapping.id % 5} if @assignment.is_calibrated == true<br />
@metareview_mappings = MetareviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# Calculate the number of reviews that the user has completed so far.<br />
@calibration_deadline = @assignment.due_dates.find_by_deadline_type_id(12)<br />
@num_reviews_total = @review_mappings.size<br />
<br />
# Add the reviews which are requested and not began.<br />
@num_regular_reviews_completed = 0<br />
@num_calibration_reviews_completed = 0<br />
@num_regular_reviews_total = 0<br />
@num_calibration_reviews_total = 0<br />
assignment_submission_due_date = @assignment.due_dates.select {|due_date| due_date.deadline_type_id == 1}.first.due_at<br />
@review_mappings.each do |map|<br />
<br />
next if map.response.empty?<br />
if map.response.last.updated_at < assignment_submission_due_date<br />
@num_calibration_reviews_completed += 1 if map.response.last.is_submitted<br />
else<br />
# @regular_review_mappings.push(map)<br />
@num_regular_reviews_completed += 1 if map.response.last.is_submitted<br />
end<br />
end<br />
@review_mappings.each do |map|<br />
if map.updated_at < assignment_submission_due_date<br />
@calibration_review_mappings.push(map)<br />
@num_calibration_reviews_total += 1<br />
else<br />
@regular_review_mappings.push(map)<br />
@num_regular_reviews_total += 1<br />
end<br />
end<br />
<br />
@num_calibration_reviews_in_progress = @num_calibration_reviews_total - @num_calibration_reviews_completed<br />
@num_regular_reviews_in_progress = @num_regular_reviews_total - @num_regular_reviews_completed<br />
<br />
# Calculate the number of metareviews that the user has completed so far.<br />
@num_metareviews_total = @metareview_mappings.size<br />
@num_metareviews_completed = 0<br />
@metareview_mappings.each do |map|<br />
@num_metareviews_completed += 1 unless map.response.empty?<br />
end<br />
@num_metareviews_in_progress = @num_metareviews_total - @num_metareviews_completed<br />
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)<br />
<br />
7.<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
<br />
context 'in assignments#edit page' do<br />
it 'has a checkbox with title \'Calibration for training?\' on \'General\' tab' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_field('Calibration for training?')<br />
end<br />
context 'when clicking \'Calibration for training?\' checkbox and clicking \'save\' button' do<br />
context '\'Calibration\' due date' do<br />
it 'works correctly' do<br />
assignment = Assignment.where(name: "Assignment1665").first<br />
instructor = User.find_by(name: "instructor6")<br />
login_as("instructor6")<br />
stub_current_user(instructor, instructor.role.name, instructor.role)<br />
visit "/assignments/#{assignment.id}/edit"<br />
click_link 'General'<br />
expect(page).to have_content('Calibration for training?')<br />
find(:css, "#assignment_is_calibrated_field").set(true)<br />
click_button 'Save'<br />
expect(page).to have_link('Calibration')<br />
click_link 'Due dates'<br />
fill_in 'calibration', with: 'Date'<br />
click_button 'Save'<br />
end<br />
end<br />
end<br />
end<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=114530CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-12-06T18:38:18Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the first round submission deadline.<br />
<br />
<br />
<br />
'''4. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''5. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the current stage is in calibration review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''6. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student submitted his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
<br />
'''7. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works when the current stage is "submit".<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Current stage is "submit".<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== What did we implement ==<br />
<br />
1. We created a file "calibration_spec.rb" in "spec/ features" and write feature tests for the calibration function.<br />
<br />
<br />
2. We created a migration file "222222222222222_add_new_deadline_type.rb" to add a new record to deadline_types model<br />
<br />
class AddNewDeadlineType < ActiveRecord::Migration<br />
def self.up<br />
execute "INSERT INTO `deadline_types` VALUES (12,'calibration_review');"<br />
end<br />
def self.down<br />
execute "DELETE FROM `deadline_types` WHERE `name` = 'calibration_review';"<br />
end<br />
end<br />
<br />
3. We added a calibration due date in due date tab if it's a calibration assignment (Modified file: app/views/assignments/edit/_due_dates.html.erb)<br />
<% if @assignment_form.assignment.is_calibrated %><br />
addDueDateTableElement(<%= @due_date_nameurl_notempty==nil ? false:@due_date_nameurl_notempty %>,'calibration', <br />
0, <%= due_date(@assignment_form.assignment, 'calibration_review').to_json.html_safe %>);<br />
<%end %><br />
<br />
4. We added calibration_review in deadline_right file (Modified file: app/models/deadline_right.rb)<br />
'calibration_review' => {<br />
'submission_allowed' => NO,<br />
'can_review' => OK,<br />
'review_of_review_allowed' => NO<br />
}<br />
<br />
5. We changed the function of finding next due date from find_by to where().order('due_at').first (Modified file: app/models/due_date.rb)<br />
next_due_date = AssignmentDueDate.where(['parent_id = ? && due_at >= ?', assignment_id, Time.zone.now]).order('due_at').first<br />
<br />
6. We changed "app/controllers/student_review_controller.rb" file to exclude calibration reviews when counting the review number. We filtered the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
@regular_review_mappings = []<br />
@calibration_review_mappings = []<br />
@participant = AssignmentParticipant.find(params[:id])<br />
return unless current_user_id?(@participant.user_id)<br />
@assignment = @participant.assignment<br />
# Find the current phase that the assignment is in.<br />
@topic_id = SignedUpTeam.topic_id(@participant.parent_id, @participant.user_id)<br />
@review_phase = @assignment.get_current_stage(@topic_id)<br />
# ACS Removed the if condition(and corressponding else) which differentiate assignments as team and individual assignments<br />
# to treat all assignments as team assignments<br />
@review_mappings = ReviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# if it is an calibrated assignment, change the response_map order in a certain way<br />
@review_mappings = @review_mappings.sort_by {|mapping| mapping.id % 5} if @assignment.is_calibrated == true<br />
@metareview_mappings = MetareviewResponseMap.where(reviewer_id: @participant.id)<br />
<br />
# Calculate the number of reviews that the user has completed so far.<br />
@calibration_deadline = @assignment.due_dates.find_by_deadline_type_id(12)<br />
@num_reviews_total = @review_mappings.size<br />
<br />
# Add the reviews which are requested and not began.<br />
@num_regular_reviews_completed = 0<br />
@num_calibration_reviews_completed = 0<br />
@num_regular_reviews_total = 0<br />
@num_calibration_reviews_total = 0<br />
assignment_submission_due_date = @assignment.due_dates.select {|due_date| due_date.deadline_type_id == 1}.first.due_at<br />
@review_mappings.each do |map|<br />
<br />
next if map.response.empty?<br />
if map.response.last.updated_at < assignment_submission_due_date<br />
@num_calibration_reviews_completed += 1 if map.response.last.is_submitted<br />
else<br />
# @regular_review_mappings.push(map)<br />
@num_regular_reviews_completed += 1 if map.response.last.is_submitted<br />
end<br />
end<br />
@review_mappings.each do |map|<br />
if map.updated_at < assignment_submission_due_date<br />
@calibration_review_mappings.push(map)<br />
@num_calibration_reviews_total += 1<br />
else<br />
@regular_review_mappings.push(map)<br />
@num_regular_reviews_total += 1<br />
end<br />
end<br />
<br />
@num_calibration_reviews_in_progress = @num_calibration_reviews_total - @num_calibration_reviews_completed<br />
@num_regular_reviews_in_progress = @num_regular_reviews_total - @num_regular_reviews_completed<br />
<br />
# Calculate the number of metareviews that the user has completed so far.<br />
@num_metareviews_total = @metareview_mappings.size<br />
@num_metareviews_completed = 0<br />
@metareview_mappings.each do |map|<br />
@num_metareviews_completed += 1 unless map.response.empty?<br />
end<br />
@num_metareviews_in_progress = @num_metareviews_total - @num_metareviews_completed<br />
@topic_id = SignedUpTeam.topic_id(@assignment.id, @participant.user_id)<br />
<br />
7.<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
[[File:test1.GIF]]<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Test3.GIF&diff=114529File:Test3.GIF2017-12-06T18:37:39Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Test2.GIF&diff=114528File:Test2.GIF2017-12-06T18:37:26Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Test1.GIF&diff=114527File:Test1.GIF2017-12-06T18:37:12Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113740CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-27T18:29:28Z<p>Nwen: /* Use Cases */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the submission deadline.<br />
<br />
<br />
'''4. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works before the calibration due date.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The calibration due date has been added.<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work has the expert review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student finished his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement. <br />
<br />
Below are the specifications and our plans to achieve them in our project.<br />
<br />
<br />
1. Specification: we need to finish all pending test related with the calibration function.<br />
<br />
Our plan: Create the file contain the test and write functional and feature test for the calibration method.<br />
<br />
<br />
2. Specification: We need to add a new kind of due date, that is calibration due date, if we want to integration calibration feature into normal assignment.<br />
<br />
Our plan : Create a migration to add a new record to deadline_types model<br />
<br />
<br />
<br />
3. Specification: After calibration is enabled, a row should appear to deal with calibration due date in "Due Dates tab". The other content of this row is just the same as other due dates.<br />
<br />
Our plan : Add a row in due dates tab with the name "Calibration"<br />
<br />
<br />
'''Picture for 2&3'''<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
<br />
4.Specification: In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
Our plan: Change the current stage column to "Calibration" if the assignment is now in calibration period<br />
<br />
<br />
'''Picture for 4'''<br />
<br />
[[File:Student view.png]]<br />
<br />
<br />
<br />
5. Specification: In student_review/list page, change the logic in this view and exclude calibration reviews when counting the review number. <br />
<br />
Our plan: Filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
<br />
<br />
6. Specification: In student_review/list page, change the wording and numbering on this view. Calibrated review 1,2,3 to represent reviews done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
Our plan: Check the review type and change the name to "Calibrated review" if it is a calibrated review.<br />
<br />
<br />
'''Picture for 5&6'''<br />
<br />
[[File:Review list.png]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Case.GIF&diff=113739File:Case.GIF2017-11-27T18:29:07Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113737CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-27T18:28:44Z<p>Nwen: /* Use Cases */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the submission deadline.<br />
<br />
<br />
'''4. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works before the calibration due date.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The calibration due date has been added.<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work has the expert review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student finished his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement. <br />
<br />
Below are the specifications and our plans to achieve them in our project.<br />
<br />
<br />
1. Specification: we need to finish all pending test related with the calibration function.<br />
<br />
Our plan: Create the file contain the test and write functional and feature test for the calibration method.<br />
<br />
<br />
2. Specification: We need to add a new kind of due date, that is calibration due date, if we want to integration calibration feature into normal assignment.<br />
<br />
Our plan : Create a migration to add a new record to deadline_types model<br />
<br />
<br />
<br />
3. Specification: After calibration is enabled, a row should appear to deal with calibration due date in "Due Dates tab". The other content of this row is just the same as other due dates.<br />
<br />
Our plan : Add a row in due dates tab with the name "Calibration"<br />
<br />
<br />
'''Picture for 2&3'''<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
<br />
4.Specification: In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
Our plan: Change the current stage column to "Calibration" if the assignment is now in calibration period<br />
<br />
<br />
'''Picture for 4'''<br />
<br />
[[File:Student view.png]]<br />
<br />
<br />
<br />
5. Specification: In student_review/list page, change the logic in this view and exclude calibration reviews when counting the review number. <br />
<br />
Our plan: Filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
<br />
<br />
6. Specification: In student_review/list page, change the wording and numbering on this view. Calibrated review 1,2,3 to represent reviews done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
Our plan: Check the review type and change the name to "Calibrated review" if it is a calibrated review.<br />
<br />
<br />
'''Picture for 5&6'''<br />
<br />
[[File:Review list.png]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113736CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-27T18:28:23Z<p>Nwen: /* Use Cases */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:case.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the submission deadline.<br />
<br />
<br />
'''4. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works before the calibration due date.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The calibration due date has been added.<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work has the expert review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student finished his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement. <br />
<br />
Below are the specifications and our plans to achieve them in our project.<br />
<br />
<br />
1. Specification: we need to finish all pending test related with the calibration function.<br />
<br />
Our plan: Create the file contain the test and write functional and feature test for the calibration method.<br />
<br />
<br />
2. Specification: We need to add a new kind of due date, that is calibration due date, if we want to integration calibration feature into normal assignment.<br />
<br />
Our plan : Create a migration to add a new record to deadline_types model<br />
<br />
<br />
<br />
3. Specification: After calibration is enabled, a row should appear to deal with calibration due date in "Due Dates tab". The other content of this row is just the same as other due dates.<br />
<br />
Our plan : Add a row in due dates tab with the name "Calibration"<br />
<br />
<br />
'''Picture for 2&3'''<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
<br />
4.Specification: In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
Our plan: Change the current stage column to "Calibration" if the assignment is now in calibration period<br />
<br />
<br />
'''Picture for 4'''<br />
<br />
[[File:Student view.png]]<br />
<br />
<br />
<br />
5. Specification: In student_review/list page, change the logic in this view and exclude calibration reviews when counting the review number. <br />
<br />
Our plan: Filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
<br />
<br />
6. Specification: In student_review/list page, change the wording and numbering on this view. Calibrated review 1,2,3 to represent reviews done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
Our plan: Check the review type and change the name to "Calibrated review" if it is a calibrated review.<br />
<br />
<br />
'''Picture for 5&6'''<br />
<br />
[[File:Review list.png]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Usecase.GIF&diff=113735File:Usecase.GIF2017-11-27T18:26:27Z<p>Nwen: uploaded a new version of &quot;File:Usecase.GIF&quot;</p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Usecase.GIF&diff=113734File:Usecase.GIF2017-11-27T18:25:49Z<p>Nwen: uploaded a new version of &quot;File:Usecase.GIF&quot;</p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Usecase.GIF&diff=113733File:Usecase.GIF2017-11-27T18:24:52Z<p>Nwen: uploaded a new version of &quot;File:Usecase.GIF&quot;</p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Usecase.GIF&diff=113732File:Usecase.GIF2017-11-27T18:24:01Z<p>Nwen: uploaded a new version of &quot;File:Usecase.GIF&quot;</p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113309CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-14T21:52:58Z<p>Nwen: /* Design Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the submission deadline.<br />
<br />
<br />
'''4. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works before the calibration due date.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The calibration due date has been added.<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work has the expert review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student finished his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement. <br />
<br />
Below are the specifications and our plans to achieve them in our project.<br />
<br />
<br />
1. Specification: we need to finish all pending test related with the calibration function.<br />
<br />
Our plan: Create the file contain the test and write functional and feature test for the calibration method.<br />
<br />
<br />
2. Specification: We need to add a new kind of due date, that is calibration due date, if we want to integration calibration feature into normal assignment.<br />
<br />
Our plan : Create a migration to add a new record to deadline_types model<br />
<br />
<br />
<br />
3. Specification: After calibration is enabled, a row should appear to deal with calibration due date in "Due Dates tab". The other content of this row is just the same as other due dates.<br />
<br />
Our plan : Add a row in due dates tab with the name "Calibration"<br />
<br />
<br />
'''Picture for 2&3'''<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
<br />
4.Specification: In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
Our plan: Change the current stage column to "Calibration" if the assignment is now in calibration period<br />
<br />
<br />
'''Picture for 4'''<br />
<br />
[[File:Student view.png]]<br />
<br />
<br />
<br />
5. Specification: In student_review/list page, change the logic in this view and exclude calibration reviews when counting the review number. <br />
<br />
Our plan: Filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
<br />
<br />
6. Specification: In student_review/list page, change the wording and numbering on this view. Calibrated review 1,2,3 to represent reviews done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
Our plan: Check the review type and change the name to "Calibrated review" if it is a calibrated review.<br />
<br />
<br />
'''Picture for 5&6'''<br />
<br />
[[File:Review list.png]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113308CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-14T21:52:41Z<p>Nwen: /* Design Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the submission deadline.<br />
<br />
<br />
'''4. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works before the calibration due date.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The calibration due date has been added.<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work has the expert review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student finished his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement. <br />
<br />
Below are the specifications and our plans to achieve them in our project.<br />
<br />
<br />
1. Specification: we need to finish all pending test related with the calibration function.<br />
our plan: Create the file contain the test and write functional and feature test for the calibration method.<br />
<br />
<br />
2. Specification: We need to add a new kind of due date, that is calibration due date, if we want to integration calibration feature into normal assignment.<br />
<br />
Our plan : Create a migration to add a new record to deadline_types model<br />
<br />
<br />
<br />
3. Specification: After calibration is enabled, a row should appear to deal with calibration due date in "Due Dates tab". The other content of this row is just the same as other due dates.<br />
<br />
Our plan : Add a row in due dates tab with the name "Calibration"<br />
<br />
<br />
'''Picture for 2&3'''<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
<br />
4.Specification: In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
Our plan: Change the current stage column to "Calibration" if the assignment is now in calibration period<br />
<br />
<br />
'''Picture for 4'''<br />
<br />
[[File:Student view.png]]<br />
<br />
<br />
<br />
5. Specification: In student_review/list page, change the logic in this view and exclude calibration reviews when counting the review number. <br />
<br />
Our plan: Filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
<br />
<br />
6. Specification: In student_review/list page, change the wording and numbering on this view. Calibrated review 1,2,3 to represent reviews done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
Our plan: Check the review type and change the name to "Calibrated review" if it is a calibrated review.<br />
<br />
<br />
'''Picture for 5&6'''<br />
<br />
[[File:Review list.png]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113305CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-14T21:50:03Z<p>Nwen: /* Test-Driven Development(TDD) */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allows students to compare their reviews with experts' reviews and learn from the comparisons.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
[[File:Calibration for training.png]]<br />
<br />
Picture above is "Calibration for training?" box in editing/creating assignment page<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can click to edit an existing assignment or create a new assignment. <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor.<br />
<br />
Post Conditions: Instructor can edit the assignment.<br />
<br />
<br />
'''2. Enable Calibration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: Instructor can select the option - "Calibration for training?" and save the assignment.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Instructor is in the editing or creating assignment page.<br />
<br />
Post Conditions: The assignment becomes a calibration assignment and the deadline for calibration now appears in the due dates tab.<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: Calibration for training? is enabled.<br />
<br />
Post Conditions: The deadline for calibration is now updated.<br />
<br />
Constraints: Calibration deadline should be before the submission deadline.<br />
<br />
<br />
'''4. Submit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description: Students can submit their works before the calibration due date.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The calibration due date has been added.<br />
<br />
Post Conditions: The database has the new works.<br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: Instructor can do expert reviews for works.<br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work is submitted.<br />
<br />
Post Conditions: The work has the expert review.<br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: Students can do calibration review.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: The assignment is a calibration assignment and the work has the expert review.<br />
<br />
Post Conditions: Students have done the calibration review.<br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description: Student can see the comparison between their reviews and the experts' reviews.<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: Instructors finished the expert reviews and this student finished his reviews.<br />
<br />
Post Conditions: NA<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. By following the process of TDD we can ensure to maintain the minimum amount of code while writing that specific function, and the developer can gain an overview of the function.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement. <br />
<br />
Below are the specifications and our plans to achieve them in our project.<br />
<br />
<br />
1. Specification: We need to add a new kind of due date, that is calibration due date, if we want to integration calibration feature into normal assignment.<br />
<br />
Our plan : Create a migration to add a new record to deadline_types model<br />
<br />
<br />
<br />
2. Specification: After calibration is enabled, a row should appear to deal with calibration due date in "Due Dates tab". The other content of this row is just the same as other due dates.<br />
<br />
Our plan : Add a row in due dates tab with the name "Calibration"<br />
<br />
<br />
'''Picture for 1&2'''<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
<br />
3.Specification: In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
Our plan: Change the current stage column to "Calibration" if the assignment is now in calibration period<br />
<br />
<br />
'''Picture for 3'''<br />
<br />
[[File:Student view.png]]<br />
<br />
<br />
<br />
4. Specification: In student_review/list page, change the logic in this view and exclude calibration reviews when counting the review number. <br />
<br />
Our plan: Filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
<br />
<br />
5. Specification: In student_review/list page, change the wording and numbering on this view. Calibrated review 1,2,3 to represent reviews done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
Our plan: Check the review type and change the name to "Calibrated review" if it is a calibrated review.<br />
<br />
<br />
'''Picture for 4&5'''<br />
<br />
[[File:Review list.png]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113079CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-13T20:17:30Z<p>Nwen: /* Design Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allow students to compare their reviews with experts' reviews. Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. But s/he needs to create a separate assignment just for calibration purpose. Ideally, calibration should become one part of the normal assignment so that students can do the calibration reviews first, learn from experts' reviews and then do the peer reviews.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can create a new assignment <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor<br />
<br />
Post Conditions: Instructor can edit created assignment <br />
<br />
<br />
'''2. Enable Caliration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: The instructor can now select the option - "Calibration for training?" <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is created<br />
<br />
Post Conditions: The deadline for calibration now appears in the due dates tab<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab<br />
<br />
Pre Conditions: Calibration for training? is enabled<br />
<br />
Post Conditions: The deadline for calibration is now updated<br />
<br />
Actors: Instructor<br />
<br />
Special cases: Calibration deadline should be before the submission deadline.<br />
<br />
'''4. Summit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions: <br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: <br />
<br />
Actors: Student<br />
<br />
Pre Conditions:<br />
<br />
Post Conditions: <br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions:<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. Also the refactoring process is safe since it happens after the test is written. Tests can also serve as a documentation to a developer.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement.<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
[[File:EnableCalibration.GIF]]<br />
<br />
<br />
[[File:StudentView.GIF]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Related Files ==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:StudentView.GIF&diff=113078File:StudentView.GIF2017-11-13T20:17:05Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113074CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-13T20:12:07Z<p>Nwen: /* Design Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allow students to compare their reviews with experts' reviews. Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. But s/he needs to create a separate assignment just for calibration purpose. Ideally, calibration should become one part of the normal assignment so that students can do the calibration reviews first, learn from experts' reviews and then do the peer reviews.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can create a new assignment <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor<br />
<br />
Post Conditions: Instructor can edit created assignment <br />
<br />
<br />
'''2. Enable Caliration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: The instructor can now select the option - "Calibration for training?" <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is created<br />
<br />
Post Conditions: The deadline for calibration now appears in the due dates tab<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab<br />
<br />
Pre Conditions: Calibration for training? is enabled<br />
<br />
Post Conditions: The deadline for calibration is now updated<br />
<br />
Actors: Instructor<br />
<br />
Special cases: Calibration deadline should be before the submission deadline.<br />
<br />
'''4. Summit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions: <br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: <br />
<br />
Actors: Student<br />
<br />
Pre Conditions:<br />
<br />
Post Conditions: <br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions:<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. Also the refactoring process is safe since it happens after the test is written. Tests can also serve as a documentation to a developer.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement.<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
<br />
<br />
[[File:EnableCalibration.GIF]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Related Files ==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113073CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-13T20:11:58Z<p>Nwen: /* Design Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''1. Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allow students to compare their reviews with experts' reviews. Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. But s/he needs to create a separate assignment just for calibration purpose. Ideally, calibration should become one part of the normal assignment so that students can do the calibration reviews first, learn from experts' reviews and then do the peer reviews.<br />
<br />
'''2. Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can create a new assignment <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor<br />
<br />
Post Conditions: Instructor can edit created assignment <br />
<br />
<br />
'''2. Enable Caliration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: The instructor can now select the option - "Calibration for training?" <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is created<br />
<br />
Post Conditions: The deadline for calibration now appears in the due dates tab<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab<br />
<br />
Pre Conditions: Calibration for training? is enabled<br />
<br />
Post Conditions: The deadline for calibration is now updated<br />
<br />
Actors: Instructor<br />
<br />
Special cases: Calibration deadline should be before the submission deadline.<br />
<br />
'''4. Summit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions: <br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: <br />
<br />
Actors: Student<br />
<br />
Pre Conditions:<br />
<br />
Post Conditions: <br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions:<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. Also the refactoring process is safe since it happens after the test is written. Tests can also serve as a documentation to a developer.<br />
<br />
== Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement.<br />
<br />
[[File:DueDate.GIF]]<br />
[[File:EnableCalibration.GIF]]<br />
<br />
== Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Related Files ==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:EnableCalibration.GIF&diff=113072File:EnableCalibration.GIF2017-11-13T20:11:37Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:DueDate.GIF&diff=113071File:DueDate.GIF2017-11-13T20:09:19Z<p>Nwen: uploaded a new version of &quot;File:DueDate.GIF&quot;</p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:DueDate.GIF&diff=113070File:DueDate.GIF2017-11-13T20:08:01Z<p>Nwen: uploaded a new version of &quot;File:DueDate.GIF&quot;</p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113067CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-13T19:58:57Z<p>Nwen: /* 6. Design Plan */</p>
<hr />
<div>== Introduction ==<br />
<br />
<br />
'''Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allow students to compare their reviews with experts' reviews. Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. But s/he needs to create a separate assignment just for calibration purpose. Ideally, calibration should become one part of the normal assignment so that students can do the calibration reviews first, learn from experts' reviews and then do the peer reviews.<br />
<br />
'''Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== 2. Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== 3. Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== 4. Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
'''1. Edit/Create Assignment''' <br />
<br />
Use Case Id: 1<br />
<br />
Use Case Description: Instructor can create a new assignment <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The user is logged in as an instructor<br />
<br />
Post Conditions: Instructor can edit created assignment <br />
<br />
<br />
'''2. Enable Caliration'''<br />
<br />
Use Case Id: 2<br />
<br />
Use Case Description: The instructor can now select the option - "Calibration for training?" <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: The assignment is created<br />
<br />
Post Conditions: The deadline for calibration now appears in the due dates tab<br />
<br />
<br />
'''3. Add calibration due date'''<br />
<br />
Use Case Id: 3<br />
<br />
Use Case Description: Instructor can set due date for calibration under due dates tab<br />
<br />
Pre Conditions: Calibration for training? is enabled<br />
<br />
Post Conditions: The deadline for calibration is now updated<br />
<br />
Actors: Instructor<br />
<br />
Special cases: Calibration deadline should be before the submission deadline.<br />
<br />
'''4. Summit work'''<br />
<br />
Use Case Id: 4 <br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
<br />
'''5. Expert Review'''<br />
<br />
Use Case Id: 5<br />
<br />
Use Case Description: <br />
<br />
Actors: Instructor<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions: <br />
<br />
<br />
'''6. Calibration review'''<br />
<br />
Use Case Id: 6<br />
<br />
Use Case Description: <br />
<br />
Actors: Student<br />
<br />
Pre Conditions:<br />
<br />
Post Conditions: <br />
<br />
<br />
'''7. View calibration result'''<br />
<br />
Use Case Id: 7<br />
<br />
Use Case Description:<br />
<br />
Actors: Student<br />
<br />
Pre Conditions: <br />
<br />
Post Conditions:<br />
<br />
== 5. Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. Also the refactoring process is safe since it happens after the test is written. Tests can also serve as a documentation to a developer.<br />
<br />
== 6. Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files or linked files between different places. Therefore, design patterns will not be required to implement.<br />
<br />
[[File:DueDate.GIF]]<br />
<br />
== 7. Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== 8. Design Patterns ==<br />
1. MVC – The project is implemented in Ruby on Rails that uses MVC<br />
architecture. It separates an application’s data model, user interface, and control<br />
logic into three distinct components (model, view and controller, respectively).<br />
<br />
2. Dry Principle – We are trying to reuse the existing functionalities in Expertiza,<br />
thus avoiding code duplication. Whenever possible, code modification based on<br />
the existing classes, controllers, or tables will be done instead of creating the<br />
new one. <br />
<br />
== Related Files ==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:DueDate.GIF&diff=113066File:DueDate.GIF2017-11-13T19:58:17Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=113051CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-13T19:06:33Z<p>Nwen: /* 4. Use Cases */</p>
<hr />
<div>== 1. Introduction ==<br />
<br />
<br />
'''1.1 Purpose'''<br />
<br />
Expertiza is an open source website based on Ruby on Rails. Calibration is one of the main feature Expertiza provides, which allow students to compare their reviews with experts' reviews. Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. But s/he needs to create a separate assignment just for calibration purpose. Ideally, calibration should become one part of the normal assignment so that students can do the calibration reviews first, learn from experts' reviews and then do the peer reviews.<br />
<br />
'''1.2 Problem Definition'''<br />
<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. However, the instructor needs to create a separate assignment just for calibration purpose of a project . Then the instructor and students can start doing peer reviews for the project with the newly created assignment . However, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary. Adding a separate assignment every time a project needs a calibration process is not efficient.<br />
<br />
This project proposes a solution to include the process of calibration in a regular assignment.<br />
<br />
== 2. Overall Description ==<br />
<br />
“Calibration for training?” feature of an assignment in Expertiza provides a solution for the Instructor of a course to effectively add a calibration to a newly created or existing assignment. The instructor should be able to turn on this feature by checking the check box "Calibration for training?" under the General tab of an assignment. The instructor will also be able to provide or change the corresponding deadline for calibration. Then students will be pre-assigned several sample assignments. After students finish one peer review , there will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== 3. Requirements ==<br />
<br />
1. The instructor shall be able to add calibration process to an newly created or existing assignment.<br />
<br />
2. In student_task/list page, current stage column shall display calibration when assignment is in calibration period.<br />
<br />
3. The added calibration of an assignment shall have it owns type of due date.<br />
<br />
4. The added calibration of an assignment shall have the same behavior as the current working calibration process.<br />
<br />
== 4. Use Cases ==<br />
[[File:Usecase.GIF]]<br />
<br />
== 5. Test-Driven Development(TDD) ==<br />
A software development process begins by writing an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It helps the developer to focus on a smaller portions of functionality at a time. Also the refactoring process is safe since it happens after the test is written. Tests can also serve as a documentation to a developer.<br />
<br />
== 6. Design Plan ==<br />
<br />
Due to the fact that the calibration feature is currently working, our approach for this project would be editing existing files<br />
To implement the feature, the existing code in one place needs to be modified or linked or called to another place, and extra code will be written in JavaScript for making calibration appear in due dates section. So design patterns will not be required to implement.<br />
<br />
== 7. Test Plan ==<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== 8. Design Patterns ==<br />
1. MVC – The project is implemented in Ruby on Rails that uses MVC<br />
architecture. It separates an application’s data model, user interface, and control<br />
logic into three distinct components (model, view and controller, respectively).<br />
<br />
2. Dry Principle – We are trying to reuse the existing functionalities in Expertiza,<br />
thus avoiding code duplication. Whenever possible, code modification based on<br />
the existing classes, controllers, or tables will be done instead of creating the<br />
new one. <br />
<br />
== Related Files ==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=File:Usecase.GIF&diff=113050File:Usecase.GIF2017-11-13T19:05:13Z<p>Nwen: </p>
<hr />
<div></div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112392CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:30:42Z<p>Nwen: /* Expertiza */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Test-Driven Development(TDD) ==<br />
A software development process begin by writes an (initially failing) automated test case that defines a desired improvement or a new function, and generate the minimum amount of code to pass that test. It help the developer to focus on a smaller portions of functionality at a time. Also the refactoring process is safe since it happens after the test is written. Test can also serve as a documentation to a developer.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
=== Steps ===<br />
<br />
We plan to write feature tests to verify our modifications<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
Adding calibration as a feature available to all assignments<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112391CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:22:10Z<p>Nwen: /* Problem Statement */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
=== Steps ===<br />
<br />
We plan to write feature tests to verify our modifications<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
Adding calibration as a feature available to all assignments<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112390CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:20:27Z<p>Nwen: /* Steps */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
=== Steps ===<br />
<br />
We plan to write feature tests to verify our modifications<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
3.When current assignment is calibration stage:<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
4. When current assignment if in review_stage:<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
Adding calibration as a feature available to all assignments<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112389CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:19:22Z<p>Nwen: /* Steps */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
=== Steps ===<br />
<br />
We plan to write feature tests to verify our modifications<br />
1. When it is in assignments#edit page:<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112386CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:07:23Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
=== Steps ===<br />
<br />
We plan to write feature tests to verify our modifications<br />
<br />
1. When it is in assignments#edit page:<br />
<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112385CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:07:12Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
<br />
<br />
=== Steps ===<br />
<br />
We plan to write feature tests to verify our modifications<br />
<br />
1. When it is in assignments#edit page:<br />
<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112384CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:06:48Z<p>Nwen: /* Problem Statement */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
<br />
<br />
<br />
<br />
We plan to write feature tests to verify our modifications<br />
<br />
1. When it is in assignments#edit page:<br />
<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112383CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:06:37Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Problem Statement ==<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Test Plan ==<br />
<br />
=== Problem Statement ===<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
<br />
<br />
<br />
<br />
We plan to write feature tests to verify our modifications<br />
<br />
1. When it is in assignments#edit page:<br />
<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112382CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:06:01Z<p>Nwen: /* Problem Statement */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Problem Statement ==<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Test Plan ==<br />
<br />
We plan to write feature tests to verify our modifications<br />
<br />
1. When it is in assignments#edit page:<br />
<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112381CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:05:51Z<p>Nwen: /* Test Plan */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Problem Statement ==<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112380CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T20:03:27Z<p>Nwen: /* Problem Statement */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Problem Statement ==<br />
Currently, calibrations is only allowed through creating an new assignment. Exist assignment can not add calibration as a feature can through edit. Therefore, the goal is making calibration become one part of the normal feature in different assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==<br />
<br />
<br />
== Test Plan ==<br />
<br />
We plan to write feature tests to verify our modifications<br />
<br />
1. When it is in assignments#edit page:<br />
<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwenhttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment_Team34&diff=112377CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment Team342017-11-07T19:58:36Z<p>Nwen: /* Expertiza */</p>
<hr />
<div>== Expertiza ==<br />
Expertiza is an open source website base on Ruby on Rails framework. It allows instructor to create and edit assignment with certain rubric whether is built in or newly created. Calibration is one of the main feature Expertiza provides. Student can review each other's work through peer reviews, this way TA/instructor can reference to the peer review save the amount of time they would spent on grading student's work. Expertiza also offers instructor the ability to check for plagiarism.<br />
<br />
== Problem Statement ==<br />
Currently, the instructor is able to calibrate the students’ peer review abilities on Expertiza. But s/he needs to create a separate assignment just for calibration purpose. Ideally, calibration should become one part of the normal assignment. The instructor could turn on this feature if necessary.<br />
<br />
Currently, the functionality of calibration works well. In assignments/edit page, when instructor checks “Calibration for training?” and save the assignment. There will be an extra tab appear named “Calibration”. At this time, the instructor needs to add several sample assignments (right now instructor needs to impersonate several students to submit sample assignments) and do expert review beforehand. After that instructor could set the due dates to review. Then, students could start working on calibration.<br />
During the calibration period, students will be pre-assign several sample assignments. And after students finish one peer review. There will be a link named “Show calibration results” to show the calibration report.<br />
<br />
== Requirement Specification ==<br />
1. If we want to integration calibration feature into normal assignment. We need to add a new kind of due date, that is calibration due date.<br />
<br />
*Write a migration to add a new record in deadline_types table.<br />
<br />
2. When instructor checks “Calibration for training?” and save the assignment. In “Due dates” tab, a row should appear to deal with calibration due date. The other content of this row is just the same as other due dates.<br />
<br />
3. In student_task/list page, current stage column should display calibration when assignment is in calibration period.<br />
<br />
4. In student_review/list page, you may notice that there are several restrictions to choose other students’ work. <br />
<br />
*Eg. “Note: You can't have more than 2 outstanding reviews. You must complete one of your outstanding reviews before selecting another. ” or “Note: You can't do more than 4 reviews according to assignment policy.”<br />
<br />
*Change the logic in this view and exclude calibration reviews when counting the review number. One easy to achieve the goal is to filter the reviews with timestamp earlier than submission due date, which means reviews are done in calibration period.<br />
<br />
*Change the wording and numbering on this view. Calibrated review 1,2,3 to represent review done in calibration period; Review 1, 2, 3 to represent reviews done in normal review period.<br />
<br />
5. Write feature tests to verify your modifications<br />
<br />
*Create calibration_spec.rb file in spec/features folder<br />
<br />
== Modified Files==<br />
<br />
<br />
== Test Plan ==<br />
<br />
We plan to write feature tests to verify our modifications<br />
<br />
1. When it is in assignments#edit page:<br />
<br />
* To check it has a checkbox with title "Calibration for training?" in assignments#edit page<br />
<br />
2. When it is in assignments#edit page and clicking "Calibration for training?" checkbox and clicking "save" button:<br />
<br />
* To check it displays a new tab named "Calibration" and adds a calibration due date in "Due dates" tab<br />
<br />
* To check it allows instructors to change and save date & time and permissions of calibration due date<br />
<br />
3.When current assignment is calibration stage:<br />
<br />
* To check it shows current stage of the assignment to be "Calibration" on student_task#view page when current assignment is in calibration stage<br />
<br />
* To check it shows "Calibration review 1,2,3..." instead of "Review 1,2,3..." on student_review#list page<br />
<br />
* To check it allows students to do calibration review and the date can be saved successfully<br />
<br />
* To check the student is able to compare the results of expert review by clicking "show calibration results" link<br />
<br />
4. When current assignment if in review_stage:<br />
<br />
* To check it excludes calibration reviews from outstanding review restriction and total review restriction<br />
<br />
* To check it shows "Review 1,2,3..." instead of "Calibration review 1,2,3..." on student_review#list page</div>Nwen