Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T06:21:38Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a method '''add_instructor_as_review'''.

1.Created a stub and mock to find the assignment team.
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a stub and mock to map the review with their response in ReviewResponseMap.
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
<pre>
1. context 'when there is no response map and no reviewer'
2. context 'when there is a reviewer'
</pre>

Using a similar approach we tested '''select_reviewer''' and '''select_metareviewer''' functions. After running the above test, we found out that all the test cases passed resulting in '''''71%''''' coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T06:20:05Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a method '''add_instructor_as_review'''.

1.Created a stub and mock to find the assignment team.
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a stub and mock to map the review with their response in ReviewResponseMap.
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
<pre>
1. context 'when there is no response map and no reviewer'
2. context 'when there is a reviewer'
</pre>

Using a similar approach we tested '''select_reviewer''' and '''select_metareviewer''' function. After running the above test, we found out that all the test cases passed resulting in '''''71%''''' coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T06:13:56Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a method '''add_instructor_as_review'''.

1.Created a stub and mock to find the assignment team.
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a stub and mock to map the review with their response in ReviewResponseMap.
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
<pre>
1. context 'when there is no response map and no reviewer'
2. context 'when there is a reviewer'
</pre>

Using a similar approach we tested '''select_reviewer''' function. After running the above test, we found out that all the test cases passed resulting in '''''71%''''' coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T06:11:48Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
<pre>
1. context 'when there is no response map and no reviewer'
2. context 'when there is a reviewer'
</pre>

Using a similar approach we tested select_reviewer function. After running the above test, we found out that all the test cases passed resulting in '''''71%''''' coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:45:52Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
<pre>
1. context 'when there is no response map and no reviewer'
2. context 'when there is a reviewer'
</pre>

After running the above test, we found out that all the test cases passed resulting in '''''71%''''' coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:42:50Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
<pre>
1. context 'when there is no response map and no reviewer'
2. context 'when there is a reviewer'

After running the above test, we found out that all the test cases passed resulting in '''''71%''''' coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:41:46Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
# 'when there is no response map and no reviewer'
# 'when there is a reviewer'

After running the above test, we found out that all the test cases passed resulting in ''71%'' coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:41:17Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
# 'when there is no response map and no reviewer'
# 'when there is a reviewer'

After running the above test, we found out that all the test cases passed resulting in 71% coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:40:27Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the following scenarios:
1.'when there is no response map and no reviewer'
2.'when there is a reviewer'

After running the above test, we found out that all the test cases passed resulting in 71% coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:23:00Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

We use the above-mentioned stubs and mocks to test the function and found out that all the test cases passed resukting in 71% coverage of review_mapping_controller.rb

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:18:56Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

1.Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:18:36Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

#Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

2.Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

3.Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:18:11Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

# Created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

# Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

Stub:
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

#Created a stub and mock to add current user as a participant in the assignment.
<pre>
Mock:
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

Stub:
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:16:32Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

# Created a stub and mock to find the assignment team
<pre>
'''Mock'''
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }

'''Stub'''
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

# Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
'''Mock'''
let(:review_response_map) do double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee')) end

'''Stub'''
allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

#Created a stub and mock to add current user as a participant in the assignment.
<pre>
'''Mock'''
allow(AssignmentParticipant).to receive(:create).with(parent_id: 1, user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(reviewer)

'''Stub'''
let(:participant) { double('AssignmentParticipant', id: 1, can_review: false, user: double('User', id: 1)) }
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:10:57Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
We added a test for a new method add_instructor_as_review

# Created a stub and mock to find the assignment team
<pre>
Mock: let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }
Stub: allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

# Created a sub and mock to map the review with their response in ReviewResponseMap
<pre>
Mock:
let(:review_response_map) do
double('ReviewResponseMap', id: 1, map_id: 1, assignment: assignment,reviewer: double('Participant', id: 1, name: 'reviewer'), reviewee: double('Participant', id: 2, name: 'reviewee'))
end
Stub: allow(ReviewResponseMap).to receive_message_chain(:where, :first).with(reviewee_id: 1, course_staff: true, reviewed_object_id: '1').with(no_args).and_return(nil)
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:07:24Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
we added a test for a new method add_instructor_as_review
1. we created a stub and mock to find the assignment team
<pre>
Mock: let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }
Stub: allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:06:58Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
we added a test for a new method add_instructor_as_review
1. we created a stub and mock to find the assignment team
<pre>
Mock:
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }
Stub:
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as students do reviews

2018-12-18T05:06:09Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We have implemented links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'Update review' link. If the deadline has passed, Update Review will change to View Review. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit the review once submitted. Instructor can update it till the final submission deadline passes.

[[File:Latest_screen_instructor.JPG]]
[[File:Ins_TA_Review.png]]

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - Icon to make an instructor's review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

[[File:Score_hover.png]]

Like shown in the above picture we can see a info button on which if we hover the text is shown.

Possible icons :
[[File:Instuctor.jpg]] [[File:Instructor1.jpg]]

== '''Test Plan''' ==
we added a test for a new method add_instructor_as_review
1. we created a stub and mock to find the assignment team
<pre>
let(:team) { double('AssignmentTeam', name: 'no one', id: 1, parent_id: 1) }
allow(AssignmentTeam).to receive(:find).with('1').and_return(team)
</pre>

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''Team''' ==
'''Members : '''
Harsh Shah,
Prachi Gupta,
Ramkumaar Kovil Kanthadai,
Raveena D'Costa.

'''Mentor :''' Dr.Edward Gehringer

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Pull Request
* https://github.com/expertiza/expertiza/pull/1304

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T18:07:23Z

Pgupta24: /* Proposed Solutions and Implementation */

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T18:02:44Z

Pgupta24: /* Proposed Solutions and Implementation */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We are planning to implement links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similiarly, just like the students instructor would not able to edit or update the review.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T18:02:24Z

Pgupta24: /* Proposed Solutions and Implementation */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

Following changes will be made to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

We are planning to implement links to ''Begin review'', ''Edit review'','' View review'' and ''Submit review'' in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similiarly, just like the students instructor would not able to edit or update the review.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T17:42:06Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

We performed the following changes to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

To do this, we added links for performing/viewing/editing/updating a review in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Perform review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. However, the course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T17:39:20Z

Pgupta24: /* Problem Statement */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

We performed the following changes to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

To do this, we added links for performing/viewing/editing/updating a review in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Perform review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. However, the course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that are conducted with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T17:25:31Z

Pgupta24: /* Proposed Solutions and Implementation */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

We performed the following changes to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

To do this, we added links for performing/viewing/editing/updating a review in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

In the second case, we can see a 'Perform review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. However, the course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that are conducted with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T17:24:15Z

Pgupta24: /* Proposed Solutions and Implementation */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

We performed the following changes to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

To do this, we added links for performing/viewing/editing/updating a review in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. However, the course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

Code snippet from the add_answer method:
<pre>
participant= Participant.find(ResponseMap.find(Response.find(response_id).map_id).reviewer_id)
user_id = participant.user_id
course = Course.find(@assignment.course_id)
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments,
course.is_ta_or_instructor?(user_id), vm_tag_prompts))
</pre>

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

Code snippet from the model:
<pre>
def is_ta_or_instructor?(user_id)
instructors = TaMapping.where(course_id: self.id).collect { |x| x.ta_id}
instructors.push(self.instructor_id)
return user_id.in?(instructors)
end
</pre>

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that are conducted with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T17:21:37Z

Pgupta24: /* Proposed Solutions and Implementation */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

We performed the following changes to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

To do this, we added links for performing/viewing/editing/updating a review in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

Code snippet from the controller:
<pre>
def add_instructor_as_reviewer
assignment_team = AssignmentTeam.find(params[:team_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment_team.parent_id).first
if reviewer.nil?
reviewer = AssignmentParticipant.create(parent_id: assignment_team.parent_id, user_id: session[:user].id, can_submit: false, can_review: true,
can_take_quiz: false, handle: 'handle')

end
@review_map_id=ReviewResponseMap.where(reviewee_id: assignment_team.id, reviewer_id: reviewer.id,
reviewed_object_id: params[:assignment_id]).first
@review_map_id=assignment_team.assign_reviewer(reviewer) if @review_map_id.nil?
redirect_to controller: 'response', action: 'new', id: @review_map_id.map_id
end
</pre>

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. However, the course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

Code snippet from the add_answer method:
<pre>
participant= Participant.find(ResponseMap.find(Response.find(response_id).map_id).reviewer_id)
user_id = participant.user_id
course = Course.find(@assignment.course_id)
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments,
course.is_ta_or_instructor?(user_id), vm_tag_prompts))
</pre>

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

Code snippet from the model:
<pre>
def is_ta_or_instructor?(user_id)
instructors = TaMapping.where(course_id: self.id).collect { |x| x.ta_id}
instructors.push(self.instructor_id)
return user_id.in?(instructors)
end
</pre>

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that are conducted with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

2018-11-20T17:21:01Z

Pgupta24: /* Test Plan */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

We performed the following changes to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

To do this, we added links for performing/viewing/editing/updating a review in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

Code snippet from the controller:
<pre>
def add_instructor_as_reviewer
assignment_team = AssignmentTeam.find(params[:team_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment_team.parent_id).first
if reviewer.nil?
reviewer = AssignmentParticipant.create(parent_id: assignment_team.parent_id, user_id: session[:user].id, can_submit: false, can_review: true,
can_take_quiz: false, handle: 'handle')

end
@review_map_id=ReviewResponseMap.where(reviewee_id: assignment_team.id, reviewer_id: reviewer.id,
reviewed_object_id: params[:assignment_id]).first
@review_map_id=assignment_team.assign_reviewer(reviewer) if @review_map_id.nil?
redirect_to controller: 'response', action: 'new', id: @review_map_id.map_id
end
</pre>

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. However, the course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

Code snippet from the add_answer method:
<pre>
participant= Participant.find(ResponseMap.find(Response.find(response_id).map_id).reviewer_id)
user_id = participant.user_id
course = Course.find(@assignment.course_id)
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments,
course.is_ta_or_instructor?(user_id), vm_tag_prompts))
</pre>

[[File:View_team.PNG | center]]

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

Code snippet from the model:
<pre>
def is_ta_or_instructor?(user_id)
instructors = TaMapping.where(course_id: self.id).collect { |x| x.ta_id}
instructors.push(self.instructor_id)
return user_id.in?(instructors)
end
</pre>

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that are conducted with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T20:13:18Z

Pgupta24: /* References */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918''' ===

Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
[[File:OODD.jpeg]]

== Implementation ==
==='''Issue #328'''===
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

==='''Issue 329'''===
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

==='''Issue 181'''===
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

==='''Issue 183'''===
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
==='''Issue #918'''===
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

==References==

#[http://152.46.16.54:8080/ Deployed link]
#[https://github.com/ppvasude/expertiza GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1267 GitHub Pull Request]

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T20:12:42Z

Pgupta24: /* Headline text */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918''' ===

Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
[[File:OODD.jpeg]]

== Implementation ==
==='''Issue #328'''===
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

==='''Issue 329'''===
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

==='''Issue 181'''===
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

==='''Issue 183'''===
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
==='''Issue #918'''===
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

==References==

#[http://152.46.16.54:8080/ Deployed link]
#[https://github.com/ppvasude/expertiza GitHub Repository]
#[ https://github.com/expertiza/expertiza/pull/1267 GitHub Pull Request]

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T20:10:23Z

Pgupta24:

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918''' ===

Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
[[File:OODD.jpeg]]

== Implementation ==
==='''Issue #328'''===
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

==='''Issue 329'''===
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

==='''Issue 181'''===
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

==='''Issue 183'''===
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
==='''Issue #918'''===
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

==References==

#[http://152.46.16.54:8080/ Deployed link]
#[https://github.com/ppvasude/expertiza GitHub Repository]
#[ https://github.com/expertiza/expertiza/pull/1267 GitHub Pull Request]

== Headline text ==

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:12:36Z

Pgupta24: /* Test Plan */

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:10:36Z

Pgupta24: /* Test Plan */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918''' ===

Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
[[File:OODD.jpeg]]

== Implementation ==
==='''Issue #328'''===
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

==='''Issue 329'''===
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

==='''Issue 181'''===
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

==='''Issue 183'''===
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
==='''Issue #918'''===
#Sql allows unicode values to be stored in the database.

== Test Plan ==
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:09:18Z

Pgupta24: /* Implementation */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918''' ===

Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
[[File:OODD.jpeg]]

== Implementation ==
==='''Issue #328'''===
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

==='''Issue 329'''===
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

==='''Issue 181'''===
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

==='''Issue 183'''===
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
==='''Issue #918'''===
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:08:18Z

Pgupta24: /* Use Case Diagram */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918''' ===

Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:07:57Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918''' ===

Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:04:52Z

Pgupta24: /* Issue #328= */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''===
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918'''=== Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:04:10Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]

=== '''Issue #328'''====
Merge teams when there is a conflict
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]

==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]

==='''Issue #918'''=== Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]

==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:02:24Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== '''The problems and their goal'''==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
==='''Issue #918'''=== Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T19:01:32Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
==='''Issue #181'''===
Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
==='''Issue #183'''===
Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:59:28Z

Pgupta24: /* Implementation */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:58:13Z

Pgupta24: /* Implementation */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue 183'''
#In the import method in user.rb file, there is a validation to check if the record length is less than 3 which is exclusive of password
#If the record length is greater than 3, it indicates that there is a password in the record and we save the password in the database
#If the length is equal to 3 then new system password is generated and saved for the user
In file app/models/user.rb
<pre>
def self.import(row_hash, _row_header, session, id = nil)
raise ArgumentError, "Only #{row_hash.length} column(s) is(are) found.
It must contain at least username, full name, email." if row_hash.length < 3
user = User.find_by_name(row_hash[:name])
puts "inside import"
if user.nil?
attributes = ImportFileHelper.define_attributes(row_hash)
user = ImportFileHelper.create_new_user(attributes, session)
if(row_hash.length>3)
user.password=row_hash[:password]
user.save
else
password = user.reset_password
end
</pre>
'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:52:02Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

=== '''Issue #329''' ===
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:49:46Z

Pgupta24: /* Issue #329 */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

=== '''Issue #329''' ===
----
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:49:07Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

== '''Issue #329''' ==
----
Rename existing team when there is a conflict

->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:47:22Z

Pgupta24: /* Implementation */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

* '''Issue #329''': Rename existing team when there is a conflict

----
->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
----

#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:42:39Z

Pgupta24:

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

* '''Issue #329''': Rename existing team when there is a conflict

----
->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.
== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:40:48Z

Pgupta24:

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

* '''Issue #329''': Rename existing team when there is a conflict

----
->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Code Snippet ==
----
'''Issue #329'''
In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue #328'''
In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:39:29Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

* '''Issue #329''': Rename existing team when there is a conflict

----
->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
[[File:Skip_password.jpg]]

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

'''Issue 181'''
#We validate the file before importing the teams. Thus, the file needs to mandatorily be uploaded in order to import team.

'''Issue #918''' Import of topics chokes on special characters
#Sql allows unicode values to be stored in the database.

== Code Snippet ==
----
'''Issue #329'''
In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue #328'''
In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:36:26Z

Pgupta24: /* The problems and their goal */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their goal==

* '''Issue #329''': Rename existing team when there is a conflict

----
->When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': Merge teams when there is a conflict

----
->When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': Validate file when importing participants
If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs.

----
->The error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the database.

----
->While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
[[File:Topics_import.jpg]]
* '''Issue #183''': Count of fields wrong in import
When importing participants (or users), it is typical not to specify a password, but rather to have the system generate it. But if you do that, Expertiza reports that each record in the file you are importing does not have enough records.

----
->When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
***insert image here***

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

'''Issue 181'''
#We validate the file before importing the teams. Thus,the file needs to mandatorily be uploaded in order to import team.

== Code Snippet ==
----
'''Issue #329'''
In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue #328'''
In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import

E1829 OSS project Duke Blue Fix import glitches

2018-11-08T18:24:23Z

Pgupta24: /* Use Case Diagram */

This wiki page is for the description of changes made to Fix import glitches.

== '''Background''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc. from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment.

== The problems and their results after resolving them==

* '''Issue #329''': When importing teams there are different options to handle conflicting team names. We added an option rename EXISTING team when a conflict exists.
[[File:Fix328.jpg]]
* '''Issue #328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.
[[File:Fix328r.jpg]]
* '''Issue #181''': If one attempts to import users or participants, and does not specify the file to import from, a NoMethodError error occurs. the error has been handled by validating the file before importing the teams, thus the file needs to mandatorily be uploaded in order to import team.
[[File:Fix181.jpg]]
* '''Issue #918''': Import of topics chokes on special characters
While importing the participants, the user can include special characters in the project description and is successfully stored in the database:
***insert image here ***
* '''Issue #183''': Count of fields wrong in import
When the user tries to upload the file to import participants, password record should be made optional and let the user upload without password record:
***insert image here***

== Use Case Diagram ==
----
[[File:OODD.jpeg]]

== Implementation ==
'''Issue #328'''
#We search the database to see if there is an existing team with the same name. In such a case we save the old team in the ‘team’ variable and set the team_exists flag to true.
#We then cal the handle_dups method which handles the case if value chosen by the user is ‘insert into existing team’, inside the code this value is represented as ‘insert’.
#Then the import_team_members function is called
#We get the user through his/her name
#If a user isn’t registered, we get a nil object and raise an ImportError
#Else we add the user to the team if he/she isn’t already in the team
#The add_member function only works till the team isn’t filled to its maximum capacity

'''Issue 329'''
#We included a new option in the duplicate handler field.
#We added a new handler in the handleDuplicates method to handle the given option as shown in the below screenshot.
#We leveraged the existing generateTeam() method and sent the existing team id to this method and replaced the existing team’s team name as follows:

'''Issue 181'''
#We validate the file before importing the teams. Thus,the file needs to mandatorily be uploaded in order to import team.

== Code Snippet ==
----
'''Issue #329'''
In file app/models/team.rb
<pre>
if handle_dups == "rename_existing" # rename: rename existing team
if teamtype.is_a?(CourseTeam)
team.update(name:self.generate_team_name(Course.find(id).name)) # update the old team name
elsif teamtype.is_a?(AssignmentTeam)
team.update(name:self.generate_team_name(Assignment.find(id).name)) # update the old team name
end
#team.update(name:self.generate_team_name(Assignment.find(id).name))
return name # send the new team name
end
</pre>

'''Issue #328'''
In file app/models/team.rb
<pre>
if handle_dups=="insert"
team.import_team_members(row_hash)
return nil

def import_team_members(starting_index = 0, row_hash)
starting_index
index = 0
row_hash[:teammembers].each do |teammember|
next if index < starting_index # not sure this will work, hash is not ordered like array
user = User.find_by(name: teammember.to_s)
if user.nil?
raise ImportError, "The user '#{teammember.to_s}' was not found. <a href='/users/new'>Create</a> this user?"
else
add_member(user) if TeamsUser.find_by(team_id: id, user_id: user.id).nil?
end
index += 1
end
end
</pre>

== Test Plan ==
----
To check the issue resolved, please follow the steps
'''Issue 918'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# Click on import topics
# Upload a file in the format given on the page, in place of topic description insert non-ASCII characters and upload
#Click on the import button.
#on the summary page, you should be able to see topic uploaded along with its description containing non-ASCII characters

'''Issue 329'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
# on import team form page, in the field "If a duplicate team name is found in the rooster" select the rename the new team and import option.
#Upload a file containing the already existing team name.
#Click on import team button
#On the summary page, you should be able to see the existing team with a new name assigned and the new team with the name uploaded.

'''Issue 328'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#On the import team form page, in the field "If a duplicate team name is found in the rooster" select the insert any new team members into the existing team option.
#Upload a file containing the already existing team name and new team members
#Click on import team button
#On the summary page, you should be able to see the existing team with additional team members

'''Issue 183'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Upload a file in the format given on the page without password field
#Click on import participant button
#You should be able to successfully import the participants

'''Issue 181'''
#Login as an instructor with the following credential
<pre>
Username: instructor6
Password: password
</pre>
#Click on import participant button without uploading a file.
#You should be able to see a prompt error to upload a file and then import