Expertiza_Wiki - User contributions [en]

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T10:51:51Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to (i) create and associate badges with courses and assignments, (ii) award badges to individual students by an instructor, (iii) automatically award badges based on some condition. However, some of the awarding functionality remains to be designed.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate other teams, whose work they have reviewed. The instructor then approves or disapproves these nominations based on the submitted work.

==Relevant code files==
* app/controllers/team_nominations_controller.rb
* app/models/team_nomination.rb
* app/views/course/edit.html.erb
* app/views/student_review/_responses.html.erb
* app/views/team_nominations/_list.html.erb
* app/views/team_nominations/list_badge_nominations.html.erb
* app/views/team_nominations/list_badges.html.erb

==Database schema changes==
Added a new table '''team_nominations''' with the following columns.
* team_id
* badge_id
* assignment_id
* status
* nominator_id

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:nominate.png]]
 
 
[[File:list_badges2.png]]

===Notes===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

===Notes===
* Multiple nominations for the same team are clubbed together to a single row on the list. The '''Nominated By''' column in this case shown a comma separated list of all the nominators.
* When a team nomination for a badge is approved, all the team participants gets awarded that badge.
* '''Submitted Work''' includes hyperlinks as well as files submitted by the team which was nominated. An instructor can thus review the work before taking an action on the nomination.

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T10:47:28Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to associate badges with courses and assignments. However, some of the awarding functionality remains to be designed. Specifically, there are three ways badges might be awarded: (i) the instructor might award them manually; (ii) students might nominate other teams for badges or (iii) badges might be awarded automatically, based on ratings by peer reviewers on specific criteria in the review rubric.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate teams, whose work they have reviewed. The instructor then approves or disapproves these nominations based on the submitted work.

==Relevant code files==
* app/controllers/team_nominations_controller.rb
* app/models/team_nomination.rb
* app/views/course/edit.html.erb
* app/views/student_review/_responses.html.erb
* app/views/team_nominations/_list.html.erb
* app/views/team_nominations/list_badge_nominations.html.erb
* app/views/team_nominations/list_badges.html.erb

==Database schema changes==
Added a new table '''team_nominations''' with the following columns.
* team_id
* badge_id
* assignment_id
* status
* nominator_id

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:nominate.png]]
 
 
[[File:list_badges2.png]]

===Notes===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

===Notes===
* Multiple nominations for the same team are clubbed together to a single row on the list. The '''Nominated By''' column in this case shown a comma separated list of all the nominators.
* When a team nomination for a badge is approved, all the team participants gets awarded that badge.
* '''Submitted Work''' includes hyperlinks as well as files submitted by the team which was nominated. An instructor can thus review the work before taking an action on the nomination.

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T10:46:34Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to associate badges with courses and assignments. However, some of the awarding functionality remains to be designed. Specifically, there are three ways badges might be awarded: (i) the instructor might award them manually; (ii) students might nominate other teams for badges or (iii) badges might be awarded automatically, based on ratings by peer reviewers on specific criteria in the review rubric.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate teams, whose work they have reviewed, for badges. The instructor then approves or disapproves these nominations based on the submitted work.

==Relevant code files==
* app/controllers/team_nominations_controller.rb
* app/models/team_nomination.rb
* app/views/course/edit.html.erb
* app/views/student_review/_responses.html.erb
* app/views/team_nominations/_list.html.erb
* app/views/team_nominations/list_badge_nominations.html.erb
* app/views/team_nominations/list_badges.html.erb

==Database schema changes==
Added a new table '''team_nominations''' with the following columns.
* team_id
* badge_id
* assignment_id
* status
* nominator_id

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:nominate.png]]
 
 
[[File:list_badges2.png]]

===Notes===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

===Notes===
* Multiple nominations for the same team are clubbed together to a single row on the list. The '''Nominated By''' column in this case shown a comma separated list of all the nominators.
* When a team nomination for a badge is approved, all the team participants gets awarded that badge.
* '''Submitted Work''' includes hyperlinks as well as files submitted by the team which was nominated. An instructor can thus review the work before taking an action on the nomination.

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T10:45:48Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to associate badges with courses and assignments. However, some of the awarding functionality remains to be designed. Specifically, there are three ways badges might be awarded: (i) the instructor might award them manually; (ii) students might nominate other teams for badges or (iii) badges might be awarded automatically, based on ratings by peer reviewers on specific criteria in the review rubric.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate teams, whose work they have reviewed, for badges. The instructor then approves or disapproves these nominations based on the submitted work.

==Relevant code files==
* app/controllers/team_nominations_controller.rb
* app/models/team_nomination.rb
* app/views/course/edit.html.erb
* app/views/student_review/_responses.html.erb
* app/views/team_nominations/_list.html.erb
* app/views/team_nominations/list_badge_nominations.html.erb
* app/views/team_nominations/list_badges.html.erb

==Database schema changes==
Added a new table '''team_nominations''' with the following columns
* team_id
* badge_id
* assignment_id
* status
* nominator_id

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:nominate.png]]
 
 
[[File:list_badges2.png]]

===Notes===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

===Notes===
* Multiple nominations for the same team are clubbed together to a single row on the list. The '''Nominated By''' column in this case shown a comma separated list of all the nominators.
* When a team nomination for a badge is approved, all the team participants gets awarded that badge.
* '''Submitted Work''' includes hyperlinks as well as files submitted by the team which was nominated. An instructor can thus review the work before taking an action on the nomination.

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T10:41:57Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to associate badges with courses and assignments. However, some of the awarding functionality remains to be designed. Specifically, there are three ways badges might be awarded: (i) the instructor might award them manually; (ii) students might nominate other teams for badges or (iii) badges might be awarded automatically, based on ratings by peer reviewers on specific criteria in the review rubric.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate teams, whose work they have reviewed, for badges. The instructor then approves or disapproves these nominations based on the submitted work.

==Relevant code files==
* app/controllers/team_nominations_controller.rb
* app/models/team_nomination.rb
* app/views/course/edit.html.erb
* app/views/student_review/_responses.html.erb
* app/views/team_nominations/_list.html.erb
* app/views/team_nominations/list_badge_nominations.html.erb
* app/views/team_nominations/list_badges.html.erb

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:nominate.png]]
 
 
[[File:list_badges2.png]]

===Notes===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

===Notes===
* Multiple nominations for the same team are clubbed together to a single row on the list. The '''Nominated By''' column in this case shown a comma separated list of all the nominators.
* When a team nomination for a badge is approved, all the team participants gets awarded that badge.
* '''Submitted Work''' includes hyperlinks as well as files submitted by the team which was nominated. An instructor can thus review the work before taking an action on the nomination.

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T09:57:05Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to associate badges with courses and assignments. However, some of the awarding functionality remains to be designed. Specifically, there are three ways badges might be awarded: (i) the instructor might award them manually; (ii) students might nominate other teams for badges or (iii) badges might be awarded automatically, based on ratings by peer reviewers on specific criteria in the review rubric.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate teams, whose work they have reviewed, for badges. The instructor then approves or disapproves these nominations based on the submitted work.

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:nominate.png]]
 
 
[[File:list_badges2.png]]

===Notes===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

===Notes===
* Multiple nominations for the same team are clubbed together to a single row on the list. The '''Nominated By''' column in this case shown a comma separated list of all the nominators.
* When a team nomination for a badge is approved, all the team participants gets awarded that badge.
* '''Submitted Work''' includes hyperlinks as well as files submitted by the team which was nominated. An instructor can thus review the work before taking an action on the nomination.

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T09:42:24Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to associate badges with courses and assignments. However, some of the awarding functionality remains to be designed. Specifically, there are three ways badges might be awarded: (i) the instructor might award them manually; (ii) students might nominate other teams for badges or (iii) badges might be awarded automatically, based on ratings by peer reviewers on specific criteria in the review rubric.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate teams, whose work they have reviewed, for badges. The instructor then approves or disapproves these nominations based on the submitted work.

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:nominate.png]]
 
 
[[File:list_badges2.png]]

===Notes===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations and awards badges to individual students.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

===Notes===
* Multiple nominations for the same team are clubbed together to a single row on the list. The '''Nominated By''' column in this case shown a comma separated list of all the nominators.
* When a team nomination for a badge is approved, all the team participants gets awarded that badge.
* '''Submitted Work''' includes hyperlinks as well as files submitted by the team which was nominated. An instructor can thus review the work before taking an action on the nomination.

File:Nominate.png

2019-05-08T09:29:49Z

Asony:

File:List nominations.png

2019-05-08T09:25:33Z

Asony: uploaded a new version of "File:List nominations.png"

File:Edit course.png

2019-05-08T09:12:30Z

Asony: uploaded a new version of "File:Edit course.png"

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T09:09:50Z

Asony:

==Introduction==
Expertiza is an application built on the MVC framework to create reusable learning objects through peer review. It currently lacks micro-credentialing, which is a way to recognize students by awarding badges, for attaining specific skills in addition to the usual coursework. Past work on the implementation of badges has interfaced Expertiza with the badging platform Credly and provided a way to associate badges with courses and assignments. However, some of the awarding functionality remains to be designed. Specifically, there are three ways badges might be awarded: (i) the instructor might award them manually; (ii) students might nominate other teams for badges or (iii) badges might be awarded automatically, based on ratings by peer reviewers on specific criteria in the review rubric.

As part of this independent study, team nominations functionality has been implemented which enables students to nominate teams, whose work they have reviewed, for badges. The instructor then approves or disapproves these nominations based on the submitted work.

==Student Flow==
This section deals with how a student can nominate other teams for badges. Students can only nominates teams whose work they have reviewed.

===Flow Diagram===
[[File:student_flow1.png]]

===Steps to nominate a team===
# Login as a student.
# Click on an assignment and then click on '''Other's work'''.
# Click on '''Nominate''', against a particular review.
# A list of available badges is shown.
# Click on '''Nominate''' against each of the badges that should be awarded for that team.
# Click on '''Submit'''

The following image below shows the badge selection screen.
 
 
[[File:list_badges2.png]]

===Status of the nomination===
The button reflects the status of the nomination.
*Once the '''Nominate''' button is clicked, the button label changes to '''Cancel Nomination'''. Click on this to cancel the nomination and then '''Submit'''. This status means that the nomination is still pending for approval/disapproval with the instructor.
*Nominations cannot be cancelled once the instructor approves it. In that case, the following message is shown beside the badge: '''This badge has already been awarded'''.
*If the instructor disapproves a nomination, the button label changes back to '''Nominate''', which means the team could be nominated again for that particular badge.

The image below shows the three different statuses, a nomination could be in.
 
 
[[File:nomination_status1.png]]

==Instructor Flow==
This section is about how an instructor manages team nominations and awards badges to individual students.

===Flow Diagram===
[[File:instructor_flow.png]]

===Steps to manage team nominations===
# Login as an instructor.
# Select a course and click on edit.
# Click on the '''Approve Nominations''' tab.
# A list of all team nominations is shown with two action buttons - '''Approve''' and '''Disapprove'''.
# Click on a particular action for each of the nominations and then click on '''Submit'''.

The following image below shows a sample selection of actions:
 
 
[[File:edit_course.png]]
 
 
[[File:list_nominations.png]]

File:Edit course.png

2019-05-08T09:08:41Z

Asony:

File:List nominations.png

2019-05-08T09:00:39Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T08:40:06Z

Asony:

File:Nomination status1.png

2019-05-08T08:39:42Z

Asony:

File:List badges2.png

2019-05-08T08:37:47Z

Asony:

File:List badges1.png

2019-05-08T08:35:59Z

Asony:

File:Instructor flow.png

2019-05-08T08:30:43Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T06:52:08Z

Asony:

File:Nomination status.png

2019-05-08T06:50:34Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T04:25:23Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T04:18:29Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T03:25:37Z

Asony:

File:List badges.png

2019-05-08T03:24:39Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T02:23:01Z

Asony: /* Flow Diagram */

File:Student flow1.png

2019-05-08T02:22:51Z

Asony:

File:Student flow.png

2019-05-08T02:13:26Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-08T02:12:48Z

Asony:

Independent Study Spring 2019/Micro-Credentialing

2019-05-07T22:25:46Z

Asony:

=Introduction=

Independent Study Spring 2019/Micro-Credentialing

2019-05-07T22:19:34Z

Asony: Created page with "xfdf"

xfdf

E1863 Issues related to assignment creation

2018-12-11T20:25:02Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were some issues related to the assignment creation. The main motive behind this project is to fix these issues and provide improved functionalities.

There are in all 5 issues that are being dealt within this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Implementation===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented:
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to delete any assignment that shows up in the list without the need for matching the assignment Id with it's own and giving Instructor the ability to delete any assignment created by a TA.

===Implementation===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:E1863-Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller.

The code at present checks for the current user and allows it the permission to delete the file if it's id matches with the Id of assignment creator.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment that is created by the '''TA'''.
# If Logged in as '''Instructor''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option if they '''did not create that assignment'''.

Automated Testing

The issue as such did not require modifying the controller spec file for assignments, since the changes were only made to the delete function and the test cases written check for the display of proper flash message that could be mapped for the modified code functionality. Only '''manual testing''' was performed to determine '''successful deletion''' by '''instructor'''.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Implementation===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would reuse the existing automation tests.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Implementation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>
<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Implementation===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

The following test was added to '''assignment_form_spec.rb''' to test if there is an error if the sum of weights of the rubrics do not add up to 0 or 100.

<pre>
context 'when both save and update_attributes method do not work with wrong rubrics weights' do
it 'changes @has_errors value to true and returns nil' do
allow(assignment_questionnaire).to receive(:save).and_return(true)
allow(assignment_questionnaire2).to receive(:update_attributes).with(assignment_questionnaire2).and_return(true)
allow(assignment_questionnaire2).to receive(:[]).with(:questionnaire_weight).and_return(12)
expect(assignment_form.update_assignment_questionnaires(attributes)).to eq(nil)
expect(assignment_form.instance_variable_get(:@has_errors)).to be true
end
end
</pre>

===References===

1. [https://www.youtube.com/watch?v=3RKdJe1lxS0 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-10T04:41:47Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would reuse the existing automation tests.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>
<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

The following test was added to '''assignment_form_spec.rb''' to test if there is an error if the sum of weights of the rubrics do not add up to 0 or 100.

<pre>
context 'when both save and update_attributes method do not work with wrong rubrics weights' do
it 'changes @has_errors value to true and returns nil' do
allow(assignment_questionnaire).to receive(:save).and_return(true)
allow(assignment_questionnaire2).to receive(:update_attributes).with(assignment_questionnaire2).and_return(true)
allow(assignment_questionnaire2).to receive(:[]).with(:questionnaire_weight).and_return(12)
expect(assignment_form.update_assignment_questionnaires(attributes)).to eq(nil)
expect(assignment_form.instance_variable_get(:@has_errors)).to be true
end
end
</pre>

===References===

1. [https://www.youtube.com/watch?v=3RKdJe1lxS0 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-08T05:33:55Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list

</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-08T04:37:51Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list

</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1323 pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-07T15:44:10Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignemtns are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

E1863 Issues related to assignment creation

2018-12-07T15:43:27Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignemtns are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

E1863 Issues related to assignment creation

2018-12-07T15:42:31Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignemtns are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up', :id=>params[:id],:topic_id => topic.id, :assignment_id =>
params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

E1863 Issues related to assignment creation

2018-12-07T15:40:38Z

Asony:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignemtns are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

E1863 Issues related to assignment creation

2018-11-21T02:50:27Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:48:53Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
end
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
'''(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))''')%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
end
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:47:27Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
'''(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))''')%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:45:40Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
{{Font color||green|(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))}})%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:42:43Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:40:06Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:38:12Z

Asony:

E1863 Issues related to assignment creation

2018-11-21T02:35:07Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:34:10Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''. '''Check the Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-21T02:32:54Z

Asony:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on "New Public Assignment"
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''. '''Check the Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a green tick mark under the Actions header and should be able to click on it and signup, which means the issue is resolved.

Automated Testing

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

Automated Testing

It involves controller testing to see if the assignment created by the TA can be deleted by instructor through the invocation of the ''delete'' method.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

== References ==

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Template Designs]

2. [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Past Wiki Docs]

3. [https://github.com/TAG1214/expertiza GitHub Repo]

E1863 Issues related to assignment creation

2018-11-13T19:19:31Z

Asony: /* Issue #1008 - Issue related to staggered deadline */

E1863 Issues related to assignment creation

2018-11-13T19:18:07Z

Asony: /* Issue #1008 - Issue related to staggered deadline */