Expertiza_Wiki - User contributions [en]

File:Usecase.jpg

2018-04-14T03:16:19Z

Ksekhar: uploaded a new version of "File:Usecase.jpg"

File:Usecase.jpg

2018-04-14T03:03:33Z

Ksekhar: uploaded a new version of "File:Usecase.jpg": Reverted to version as of 02:55, 14 April 2018

File:Usecase.jpg

2018-04-14T03:00:04Z

Ksekhar: uploaded a new version of "File:Usecase.jpg"

File:Usecase.jpg

2018-04-14T02:55:41Z

Ksekhar: uploaded a new version of "File:Usecase.jpg"

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-14T00:11:29Z

Ksekhar: /* Files to be modified */

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
* expertiza/app/models/awarded_badge.rb

=== Controllers ===
=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
* expertiza/app/views/student_task/list.html.erb

=== Database changes ===
* Add a new column 'approval_status' in the awarded_badges table

=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb
* expertiza/app/views/assignments/edit/_approve_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-13T23:49:31Z

Ksekhar: /* Approval of badges by instructor */

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges.

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
=== Controllers ===
=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb

=== Database changes ===
=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-13T23:45:47Z

Ksekhar: /* Files to be modified */

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
=== Controllers ===
=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb

=== Database changes ===
=== New Files ===
* expertiza/app/views/assignments/edit/_add_new_badge.html.erb

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-13T23:43:15Z

Ksekhar: /* Views */

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
=== Controllers ===
=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb

=== Database changes ===

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-13T23:27:30Z

Ksekhar: /* Views */

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
=== Controllers ===
=== Views ===
* expertiza/app/views/assignments/edit/_badges.html.erb
* expertiza/app/views/student_teams/view.html.erb
* expertiza/app/views/review_mapping/_review_report.html.erb
*

=== Database changes ===

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-13T23:11:38Z

Ksekhar:

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

== Files to be modified ==

=== Models ===
=== Controllers ===
=== Views ===
=== Database changes ===

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-06T19:29:13Z

Ksekhar: /* Flowchart */

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Usecase Diagram ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-06T19:25:52Z

Ksekhar: /* Previous Implementation */

= Background And Motivation =

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

==Previous Implementation==

The use of badges will encourage students to have a visual motivation based on their achievements and thus perform better. This has the ability to improve the overall class performance.

With such an aim of improving the over all class performance, badging system for Expertiza was implemented, as an [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly earlier project]]. In that implementation, certain students are awarded badges when certain criteria are met which may include exceptional academic performance in assignments, project submissions etc. Two such badges, Good Reviewer and Good Team mater were implemented, with students receiving them automatically based on a threshold score in those categories. This was a static system with fixed number of badges.

The team had implemented the system, by introduction of 3 new badge related tables

1. “badges” :- id , name, description

2. “assignment_badges” :- id, badge_id, assignment_id, threshold

3. “awarded_badges” :- id, badge_id,participant_id

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

4. All badges assigned, must require the approval of the instructor, who would manually accept/deny them before final posting.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Akshay Ravichandran

2. Arunkumar Krishnamoorthy

3. Harish Pullagurla

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Flowchart ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes.

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

Here are some tests we have in mind:

1. Can save a badge with a valid name, description, and image.

2. Cannot save a badge with an invalid name.

3. Cannot save a badge with empty description.

4. Cannot save a badge without an image path.

5. Check that all badge names are rendered in the "Badges" tab.

6. Check that an instructor can approve student-suggested badges.

7. Check that an approved badge is rendered on student's assignments page if it is approved.

8. Check that a student can not see a badge on assignments page if it is not approved.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

File:Usecase.jpg

2018-04-06T03:37:37Z

Ksekhar: uploaded a new version of "File:Usecase.jpg"

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-06T03:31:44Z

Ksekhar: /* Team Members */

= Background =

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. All badges assigned by students must require the approval of the instructor, who would manually accept/deny them before final posting.

4. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Harish Pullagurla

2. Akshay Ravichandran

3. Arunkumar Krishnamoorthy

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Flowchart ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes. The view we have in mind would look something similar to what is shown below:

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-06T03:30:47Z

Ksekhar: /* Team Members */

= Background =

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. All badges assigned by students must require the approval of the instructor, who would manually accept/deny them before final posting.

4. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

= Team Members =
Students who collaborated to work on this problem statement are :

1. Harish Pullagurla ( hpullag@ncsu.edu )

2. Akshay Ravichandran

3. Arunkumar Krishnamoorthy

4. Krithika Sekhar

Mentor:- Zhewei Hu (zhu6@ncsu.edu)

= Implementation Plan =
The following steps briefly describe the implementation steps planned to be taken during the course of this project

== Flowchart ==

[[File:Usecase.jpg]]

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes. The view we have in mind would look something similar to what is shown below:

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

[[File:Badge_good_reviewer.png | center]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Visibility of assigned badges to Students ==

Once approved by the instructor, the badges assigned would be visible in the assignment tab of the website as shown in the image. Badges corresponding to each of the assignments will be seen on the row of that particular assignment.

[[File:badge_final_view.png|center]]

= Test Plan =
All new code to be added would be thoroughly tested using TDD methodology.

= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-06T01:21:45Z

Ksekhar:

= Background =

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. All badges assigned by students must require the approval of the instructor, who would manually accept/deny them before final posting.

4. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

= Flowchart =

[[File:Usecase.jpg]]

= Implementation Plan =

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as specified in '''expertiza/app/views/assignments/edit/_badges.html.erb'''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable to this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes. The view we have in mind would look something similar to what is shown below:

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|center|]]

== Assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the '''expertiza/app/views/review_mapping/_review_report.html.erb''' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

= Test Plan =
= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

File:Usecase.jpg

2018-04-06T01:19:10Z

Ksekhar:

CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging

2018-04-06T01:04:28Z

Ksekhar:

= Background =

= Problem Statement =
The aim of this project is to extend the functionality of badging that was implemented last previously. [[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly (Previous Implementation)]].

The primary objectives for this project are as follows:

1. Allowing Instructor to create new badges - which involves adding name and badge image.

2. Students must be able to assign "Good Teammate" badges during the teammate review periods.

3. All badges assigned by students must require the approval of the instructor, who would manually accept/deny them before final posting.

4. Instructors and TAs must be able to manually assign "Good Reviewer" badges.

= Flowchart =

= Implementation Plan =

== Creation of new badges ==
When an assignment is created/edited, there is a checkbox called ''"Has Badges?"''. Checking this renders the ''"Badges"'' tab. This tab currently lists the two available badges namely '''"Good Reviewer"''' and '''"Good Teammate"''' as ''specified in expertiza/app/views/assignments/edit/_badges.html.erb''.

We intend to change this view to allow an instructor to add a new badge, and select all badges that will be applicable for this assignment. For this, we intend to display a link called '''"Add"''' and list all the available badges as a series checkboxes. The view we have in mind would look something similar to what is shown below:

Clicking on '''"Add"''' would redirect to a new view, where there is a simple form to add a new badge. The form fields would include ''Badge Name'', ''Image'' and ''Description''.

== Assignment of "Good Teammate" badges by student ==

Presently, the assignment of these badges is done based on a threshold, which is assigned by the TA. We would like to allow students to be able to directly add these badges to their fellow students.

In order to allow students to assign "Good Teammate" badges, the '''expertiza/app/views/student_teams/view.html.erb''' view needs to be edited. The UI we have in mind is as shown below:

[[File:Team_mate_review.png|left|alt text]]

== Approval of badges by instructor ==

Currently, the '''awarded_badges''' table has no column to indicate the approval status of an awarded badge. We would need to run a db migration to include this column. Also, a new view needs to be created to allow instructors to approve student-suggested badges. The view we have in mind is as shown below:

== Manual assignment of "Good Reviewer" badges ==

Instructors and TAs can see a review report for an assignment that they are managing as given in the ''expertiza/app/views/review_mapping/_review_report.html.erb'' view. They can add grades and comments to every reviewer. We would like to add another column to this view to allow that allows the instructor/TA to click on a checkbox to indicate if this reviewer is a "Good Reviewer". The view we have in mind will look as follows:

= Test Plan =
= References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A2._Lightweight_badging_system_based_on_Credly Previous Badge implementation page ]

CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors

2018-04-03T02:47:51Z

Ksekhar: /* Manual UI Testing */

== Introduction ==
=== Background ===
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University], Raleigh.

Currently, when an '''instructor''' logs into Expertiza, he/she sees the following menu items across the top:

''Home Manage content Survey Deployments Assignments Course Evaluation Profile Contact Us''

And, a student can see the following menu items across the top:

''Home Assignments Pending Surveys Profile Contact Us''

On the instructor’s “Manage content” menu, one of the options is “Assignments”. Having “Assignments” appear in two places is potentially confusing. “Manage content > Assignments” allows the instructor to edit and create assignments, whereas the “Assignments” menu (that both students and instructors) see allows the instructor to participate in assignments.

Therefore, it makes sense to create a '''student view''' for instructors, which will enable them to see menu items that are only related to students. This will help resolve the confusion.

=== Problem statement ===
Create a '''student view''' for instructors. When in '''student view''', an instructor must not be able to view ''"Manage content"'' and ''"Survey Deployments"'' menu items, and must be able to switch back to the '''instructor view''' (the default view that an instructor first sees when he/she logs in). When in '''instructor view''', an instructor must not be able to view the ''"Assignment"'' and ''"Course Evaluation"'' menu items.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/views/menu_items/_suckerfish.html.erb ===
This file is responsible for rendering all menu items and their children (if any).

A condition was needed to check if the current menu item that is to be rendered is in the list of hidden menu items. The ''hidden_menu_items'' session variable holds the IDs of menu items that must not be rendered. This applies only when the type of user currently logged in is an instructor. Hence, the following condition was added.
<pre>
display_item_condition = (session[:user].role.instructor?)?(session[:hidden_menu_items].include?item_id)?false:true:true
</pre>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/app/helpers/menu_items_helper.rb ===

This is a helper for deciding what menu items must be hidden.
 The ''update_hidden_menu_items_for_student_view'' method is used to hide the ''Survey Deployments'' and ''Manage Instructor Content'' menu items. It does this by including the menu item IDs of these two menus in the ''hidden_menu_items'' session variable. (The ''hidden_menu_item'' variable will be used by _suckerfish.html.erb to decide whether or not to render a given menu item).
 Similarly, the ''update_hidden_menu_items_for_instructor_view'' method is used to hide the ''Assignments'' and ''Course Evaluation'' menu items.
 The ''set_hidden_menu_items'' method is used to set check if the given user is an instructor. If it is, then the ''update_hidden_menu_items_for_instructor_view'' method is called. This method is used to ensure that only those items that must be visible to an instructor view are visible to an instructor when he logs in for the first time. The method has been designed in this way because, in the future, other menu items may need to be hidden based on the user type.
<pre>
module MenuItemsHelper
# sets hidden_menu_items for the given user if
# user is an instructor. This method is needed to set
# the hidden_menu_items during initial login by instructor.
def self.set_hidden_menu_items(user, session)
if user.role.instructor?
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
else
session[:hidden_menu_items] = []
end
end

# updates hidden_menu_items in session object when an instructor is
# in student view
def self.update_hidden_menu_items_for_student_view(session)
# 35 - Survey Deployments, 37 - Manage Instructor Content
session[:hidden_menu_items] = [35, 37]
end

# updates hidden_menu_items in session object when an instructor is
# in instructor view
def self.update_hidden_menu_items_for_instructor_view(session)
# 26 - Assignments, 30 - Course Evaluation
session[:hidden_menu_items] = [26, 30]
end
end
</pre>

=== expertiza/app/controllers/auth_controller.rb ===
The ''after_login'' method in this controller sets up the session object after the user logs in, so it is a good candidate to include the initial set up of the ''hidden_menu_items'' session variable.

The following lines were added to the ''after_login'' method. This call is intended to set the 'hidden_menu_items' variable in the session object when an instructor logs in for the first time. This is done so that the instructor is by default in Instructor View when he logs in. (i.e ''Assignments'' and ''Course Evaluation'' are hidden).
<pre>
# hide menu items based on type of user
MenuItemsHelper.set_hidden_menu_items(user,session)
</pre>

The following lines were added to the ''clear_session'' method. These lines clear the ''student_view'' and ''hidden_menu_items'' session variables.
<pre>
session[:student_view] = nil
session[:hidden_menu_items] = nil
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

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

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

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

RSpec Documentation
* http://rspec.info/documentation/

CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors

2018-04-03T02:43:43Z

Ksekhar: /* Automated Test Plan */

== Introduction ==
=== Background ===
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University], Raleigh.

Currently, when an '''instructor''' logs into Expertiza, he/she sees the following menu items across the top:

''Home Manage content Survey Deployments Assignments Course Evaluation Profile Contact Us''

And, a student can see the following menu items across the top:

''Home Assignments Pending Surveys Profile Contact Us''

On the instructor’s “Manage content” menu, one of the options is “Assignments”. Having “Assignments” appear in two places is potentially confusing. “Manage content > Assignments” allows the instructor to edit and create assignments, whereas the “Assignments” menu (that both students and instructors) see allows the instructor to participate in assignments.

Therefore, it makes sense to create a '''student view''' for instructors, which will enable them to see menu items that are only related to students. This will help resolve the confusion.

=== Problem statement ===
Create a '''student view''' for instructors. When in '''student view''', an instructor must not be able to view ''"Manage content"'' and ''"Survey Deployments"'' menu items, and must be able to switch back to the '''instructor view''' (the default view that an instructor first sees when he/she logs in). When in '''instructor view''', an instructor must not be able to view the ''"Assignment"'' and ''"Course Evaluation"'' menu items.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/views/menu_items/_suckerfish.html.erb ===
This file is responsible for rendering all menu items and their children (if any).

A condition was needed to check if the current menu item that is to be rendered is in the list of hidden menu items. The ''hidden_menu_items'' session variable holds the IDs of menu items that must not be rendered. This applies only when the type of user currently logged in is an instructor. Hence, the following condition was added.
<pre>
display_item_condition = (session[:user].role.instructor?)?(session[:hidden_menu_items].include?item_id)?false:true:true
</pre>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/app/helpers/menu_items_helper.rb ===

This is a helper for deciding what menu items must be hidden.
 The ''update_hidden_menu_items_for_student_view'' method is used to hide the ''Survey Deployments'' and ''Manage Instructor Content'' menu items. It does this by including the menu item IDs of these two menus in the ''hidden_menu_items'' session variable. (The ''hidden_menu_item'' variable will be used by _suckerfish.html.erb to decide whether or not to render a given menu item).
 Similarly, the ''update_hidden_menu_items_for_instructor_view'' method is used to hide the ''Assignments'' and ''Course Evaluation'' menu items.
 The ''set_hidden_menu_items'' method is used to set check if the given user is an instructor. If it is, then the ''update_hidden_menu_items_for_instructor_view'' method is called. This method is used to ensure that only those items that must be visible to an instructor view are visible to an instructor when he logs in for the first time. The method has been designed in this way because, in the future, other menu items may need to be hidden based on the user type.
<pre>
module MenuItemsHelper
# sets hidden_menu_items for the given user if
# user is an instructor. This method is needed to set
# the hidden_menu_items during initial login by instructor.
def self.set_hidden_menu_items(user, session)
if user.role.instructor?
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
else
session[:hidden_menu_items] = []
end
end

# updates hidden_menu_items in session object when an instructor is
# in student view
def self.update_hidden_menu_items_for_student_view(session)
# 35 - Survey Deployments, 37 - Manage Instructor Content
session[:hidden_menu_items] = [35, 37]
end

# updates hidden_menu_items in session object when an instructor is
# in instructor view
def self.update_hidden_menu_items_for_instructor_view(session)
# 26 - Assignments, 30 - Course Evaluation
session[:hidden_menu_items] = [26, 30]
end
end
</pre>

=== expertiza/app/controllers/auth_controller.rb ===
The ''after_login'' method in this controller sets up the session object after the user logs in, so it is a good candidate to include the initial set up of the ''hidden_menu_items'' session variable.

The following lines were added to the ''after_login'' method. This call is intended to set the 'hidden_menu_items' variable in the session object when an instructor logs in for the first time. This is done so that the instructor is by default in Instructor View when he logs in. (i.e ''Assignments'' and ''Course Evaluation'' are hidden).
<pre>
# hide menu items based on type of user
MenuItemsHelper.set_hidden_menu_items(user,session)
</pre>

The following lines were added to the ''clear_session'' method. These lines clear the ''student_view'' and ''hidden_menu_items'' session variables.
<pre>
session[:student_view] = nil
session[:hidden_menu_items] = nil
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

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

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

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

RSpec Documentation
* http://rspec.info/documentation/

CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors

2018-04-03T02:32:29Z

Ksekhar: /* Team */

== Introduction ==
=== Background ===
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University], Raleigh.

Currently, when an '''instructor''' logs into Expertiza, he/she sees the following menu items across the top:

''Home Manage content Survey Deployments Assignments Course Evaluation Profile Contact Us''

And, a student can see the following menu items across the top:

''Home Assignments Pending Surveys Profile Contact Us''

On the instructor’s “Manage content” menu, one of the options is “Assignments”. Having “Assignments” appear in two places is potentially confusing. “Manage content > Assignments” allows the instructor to edit and create assignments, whereas the “Assignments” menu (that both students and instructors) see allows the instructor to participate in assignments.

Therefore, it makes sense to create a '''student view''' for instructors, which will enable them to see menu items that are only related to students. This will help resolve the confusion.

=== Problem statement ===
Create a '''student view''' for instructors. When in '''student view''', an instructor must not be able to view ''"Manage content"'' and ''"Survey Deployments"'' menu items, and must be able to switch back to the '''instructor view''' (the default view that an instructor first sees when he/she logs in). When in '''instructor view''', an instructor must not be able to view the ''"Assignment"'' and ''"Course Evaluation"'' menu items.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/views/menu_items/_suckerfish.html.erb ===
This file is responsible for rendering all menu items and their children (if any).

A condition was needed to check if the current menu item that is to be rendered is in the list of hidden menu items. The ''hidden_menu_items'' session variable holds the IDs of menu items that must not be rendered. This applies only when the type of user currently logged in is an instructor. Hence, the following condition was added.
<pre>
display_item_condition = (session[:user].role.instructor?)?(session[:hidden_menu_items].include?item_id)?false:true:true
</pre>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/app/helpers/menu_items_helper.rb ===

This is a helper for deciding what menu items must be hidden.
 The ''update_hidden_menu_items_for_student_view'' method is used to hide the ''Survey Deployments'' and ''Manage Instructor Content'' menu items. It does this by including the menu item IDs of these two menus in the ''hidden_menu_items'' session variable. (The ''hidden_menu_item'' variable will be used by _suckerfish.html.erb to decide whether or not to render a given menu item).
 Similarly, the ''update_hidden_menu_items_for_instructor_view'' method is used to hide the ''Assignments'' and ''Course Evaluation'' menu items.
 The ''set_hidden_menu_items'' method is used to set check if the given user is an instructor. If it is, then the ''update_hidden_menu_items_for_instructor_view'' method is called. This method is used to ensure that only those items that must be visible to an instructor view are visible to an instructor when he logs in for the first time. The method has been designed in this way because, in the future, other menu items may need to be hidden based on the user type.
<pre>
module MenuItemsHelper
# sets hidden_menu_items for the given user if
# user is an instructor. This method is needed to set
# the hidden_menu_items during initial login by instructor.
def self.set_hidden_menu_items(user, session)
if user.role.instructor?
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
else
session[:hidden_menu_items] = []
end
end

# updates hidden_menu_items in session object when an instructor is
# in student view
def self.update_hidden_menu_items_for_student_view(session)
# 35 - Survey Deployments, 37 - Manage Instructor Content
session[:hidden_menu_items] = [35, 37]
end

# updates hidden_menu_items in session object when an instructor is
# in instructor view
def self.update_hidden_menu_items_for_instructor_view(session)
# 26 - Assignments, 30 - Course Evaluation
session[:hidden_menu_items] = [26, 30]
end
end
</pre>

=== expertiza/app/controllers/auth_controller.rb ===
The ''after_login'' method in this controller sets up the session object after the user logs in, so it is a good candidate to include the initial set up of the ''hidden_menu_items'' session variable.

The following lines were added to the ''after_login'' method. This call is intended to set the 'hidden_menu_items' variable in the session object when an instructor logs in for the first time. This is done so that the instructor is by default in Instructor View when he logs in. (i.e ''Assignments'' and ''Course Evaluation'' are hidden).
<pre>
# hide menu items based on type of user
MenuItemsHelper.set_hidden_menu_items(user,session)
</pre>

The following lines were added to the ''clear_session'' method. These lines clear the ''student_view'' and ''hidden_menu_items'' session variables.
<pre>
session[:student_view] = nil
session[:hidden_menu_items] = nil
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines in the file spec/features/airbrake_expection_errors_feature_tests_spec.rb are to be modified:

<pre>
it "can access to '/tree_display/list' after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments''are hidden when the instructor switches to student view. The following lines in the file spec/features/airbrake_expection_errors_feature_tests_spec.rb are to be added:

<pre>
it "can access to '/tree_display/list' when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

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

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

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

RSpec Documentation
* http://rspec.info/documentation/

CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors

2018-04-03T02:30:39Z

Ksekhar: /* Automated Test Plan */

== Introduction ==
=== Background ===
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University], Raleigh.

Currently, when an '''instructor''' logs into Expertiza, he/she sees the following menu items across the top:

''Home Manage content Survey Deployments Assignments Course Evaluation Profile Contact Us''

And, a student can see the following menu items across the top:

''Home Assignments Pending Surveys Profile Contact Us''

On the instructor’s “Manage content” menu, one of the options is “Assignments”. Having “Assignments” appear in two places is potentially confusing. “Manage content > Assignments” allows the instructor to edit and create assignments, whereas the “Assignments” menu (that both students and instructors) see allows the instructor to participate in assignments.

Therefore, it makes sense to create a '''student view''' for instructors, which will enable them to see menu items that are only related to students. This will help resolve the confusion.

=== Problem statement ===
Create a '''student view''' for instructors. When in '''student view''', an instructor must not be able to view ''"Manage content"'' and ''"Survey Deployments"'' menu items, and must be able to switch back to the '''instructor view''' (the default view that an instructor first sees when he/she logs in). When in '''instructor view''', an instructor must not be able to view the ''"Assignment"'' and ''"Course Evaluation"'' menu items.

=== Team ===
# Akshay Ravichandran
# Krithika Sekhar
# Sameer Poudwal

'''Mentor''' - Dr. Ed Gehringer

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/views/menu_items/_suckerfish.html.erb ===
This file is responsible for rendering all menu items and their children (if any).

A condition was needed to check if the current menu item that is to be rendered is in the list of hidden menu items. The ''hidden_menu_items'' session variable holds the IDs of menu items that must not be rendered. This applies only when the type of user currently logged in is an instructor. Hence, the following condition was added.
<pre>
display_item_condition = (session[:user].role.instructor?)?(session[:hidden_menu_items].include?item_id)?false:true:true
</pre>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/app/helpers/menu_items_helper.rb ===

This is a helper for deciding what menu items must be hidden.
 The ''update_hidden_menu_items_for_student_view'' method is used to hide the ''Survey Deployments'' and ''Manage Instructor Content'' menu items. It does this by including the menu item IDs of these two menus in the ''hidden_menu_items'' session variable. (The ''hidden_menu_item'' variable will be used by _suckerfish.html.erb to decide whether or not to render a given menu item).
 Similarly, the ''update_hidden_menu_items_for_instructor_view'' method is used to hide the ''Assignments'' and ''Course Evaluation'' menu items.
 The ''set_hidden_menu_items'' method is used to set check if the given user is an instructor. If it is, then the ''update_hidden_menu_items_for_instructor_view'' method is called. This method is used to ensure that only those items that must be visible to an instructor view are visible to an instructor when he logs in for the first time. The method has been designed in this way because, in the future, other menu items may need to be hidden based on the user type.
<pre>
module MenuItemsHelper
# sets hidden_menu_items for the given user if
# user is an instructor. This method is needed to set
# the hidden_menu_items during initial login by instructor.
def self.set_hidden_menu_items(user, session)
if user.role.instructor?
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
else
session[:hidden_menu_items] = []
end
end

# updates hidden_menu_items in session object when an instructor is
# in student view
def self.update_hidden_menu_items_for_student_view(session)
# 35 - Survey Deployments, 37 - Manage Instructor Content
session[:hidden_menu_items] = [35, 37]
end

# updates hidden_menu_items in session object when an instructor is
# in instructor view
def self.update_hidden_menu_items_for_instructor_view(session)
# 26 - Assignments, 30 - Course Evaluation
session[:hidden_menu_items] = [26, 30]
end
end
</pre>

=== expertiza/app/controllers/auth_controller.rb ===
The ''after_login'' method in this controller sets up the session object after the user logs in, so it is a good candidate to include the initial set up of the ''hidden_menu_items'' session variable.

The following lines were added to the ''after_login'' method. This call is intended to set the 'hidden_menu_items' variable in the session object when an instructor logs in for the first time. This is done so that the instructor is by default in Instructor View when he logs in. (i.e ''Assignments'' and ''Course Evaluation'' are hidden).
<pre>
# hide menu items based on type of user
MenuItemsHelper.set_hidden_menu_items(user,session)
</pre>

The following lines were added to the ''clear_session'' method. These lines clear the ''student_view'' and ''hidden_menu_items'' session variables.
<pre>
session[:student_view] = nil
session[:hidden_menu_items] = nil
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines in the file spec/features/airbrake_expection_errors_feature_tests_spec.rb are to be modified:

<pre>
it "can access to '/tree_display/list' after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments''are hidden when the instructor switches to student view. The following lines in the file spec/features/airbrake_expection_errors_feature_tests_spec.rb are to be added:

<pre>
it "can access to '/tree_display/list' when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

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

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

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

RSpec Documentation
* http://rspec.info/documentation/

CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors

2018-04-03T02:11:09Z

Ksekhar: /* Automated Test Plan */

== Introduction ==
=== Background ===
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University], Raleigh.

Currently, when an '''instructor''' logs into Expertiza, he/she sees the following menu items across the top:

''Home Manage content Survey Deployments Assignments Course Evaluation Profile Contact Us''

And, a student can see the following menu items across the top:

''Home Assignments Pending Surveys Profile Contact Us''

On the instructor’s “Manage content” menu, one of the options is “Assignments”. Having “Assignments” appear in two places is potentially confusing. “Manage content > Assignments” allows the instructor to edit and create assignments, whereas the “Assignments” menu (that both students and instructors) see allows the instructor to participate in assignments.

Therefore, it makes sense to create a '''student view''' for instructors, which will enable them to see menu items that are only related to students. This will help resolve the confusion.

=== Problem statement ===
Create a '''student view''' for instructors. When in '''student view''', an instructor must not be able to view ''"Manage content"'' and ''"Survey Deployments"'' menu items, and must be able to switch back to the '''instructor view''' (the default view that an instructor first sees when he/she logs in). When in '''instructor view''', an instructor must not be able to view the ''"Assignment"'' and ''"Course Evaluation"'' menu items.

=== Team ===
# Akshay Ravichandran
# Krithika Sekhar
# Sameer Poudwal

'''Mentor''' - Dr. Ed Gehringer

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/views/menu_items/_suckerfish.html.erb ===
This file is responsible for rendering all menu items and their children (if any).

A condition was needed to check if the current menu item that is to be rendered is in the list of hidden menu items. The ''hidden_menu_items'' session variable holds the IDs of menu items that must not be rendered. This applies only when the type of user currently logged in is an instructor. Hence, the following condition was added.
<pre>
display_item_condition = (session[:user].role.instructor?)?(session[:hidden_menu_items].include?item_id)?false:true:true
</pre>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/app/helpers/menu_items_helper.rb ===

This is a helper for deciding what menu items must be hidden.
 The ''update_hidden_menu_items_for_student_view'' method is used to hide the ''Survey Deployments'' and ''Manage Instructor Content'' menu items. It does this by including the menu item IDs of these two menus in the ''hidden_menu_items'' session variable. (The ''hidden_menu_item'' variable will be used by _suckerfish.html.erb to decide whether or not to render a given menu item).
 Similarly, the ''update_hidden_menu_items_for_instructor_view'' method is used to hide the ''Assignments'' and ''Course Evaluation'' menu items.
 The ''set_hidden_menu_items'' method is used to set check if the given user is an instructor. If it is, then the ''update_hidden_menu_items_for_instructor_view'' method is called. This method is used to ensure that only those items that must be visible to an instructor view are visible to an instructor when he logs in for the first time. The method has been designed in this way because, in the future, other menu items may need to be hidden based on the user type.
<pre>
module MenuItemsHelper
# sets hidden_menu_items for the given user if
# user is an instructor. This method is needed to set
# the hidden_menu_items during initial login by instructor.
def self.set_hidden_menu_items(user, session)
if user.role.instructor?
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
else
session[:hidden_menu_items] = []
end
end

# updates hidden_menu_items in session object when an instructor is
# in student view
def self.update_hidden_menu_items_for_student_view(session)
# 35 - Survey Deployments, 37 - Manage Instructor Content
session[:hidden_menu_items] = [35, 37]
end

# updates hidden_menu_items in session object when an instructor is
# in instructor view
def self.update_hidden_menu_items_for_instructor_view(session)
# 26 - Assignments, 30 - Course Evaluation
session[:hidden_menu_items] = [26, 30]
end
end
</pre>

=== expertiza/app/controllers/auth_controller.rb ===
The ''after_login'' method in this controller sets up the session object after the user logs in, so it is a good candidate to include the initial set up of the ''hidden_menu_items'' session variable.

The following lines were added to the ''after_login'' method. This call is intended to set the 'hidden_menu_items' variable in the session object when an instructor logs in for the first time. This is done so that the instructor is by default in Instructor View when he logs in. (i.e ''Assignments'' and ''Course Evaluation'' are hidden).
<pre>
# hide menu items based on type of user
MenuItemsHelper.set_hidden_menu_items(user,session)
</pre>

The following lines were added to the ''clear_session'' method. These lines clear the ''student_view'' and ''hidden_menu_items'' session variables.
<pre>
session[:student_view] = nil
session[:hidden_menu_items] = nil
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
# Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines in the file spec/features/airbrake_expection_errors_feature_tests_spec.rb are to be modified:

# Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

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

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

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

RSpec Documentation
* http://rspec.info/documentation/

CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors

2018-04-03T01:55:47Z

Ksekhar:

== Introduction ==
=== Background ===
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University], Raleigh.

Currently, when an '''instructor''' logs into Expertiza, he/she sees the following menu items across the top:

''Home Manage content Survey Deployments Assignments Course Evaluation Profile Contact Us''

And, a student can see the following menu items across the top:

''Home Assignments Pending Surveys Profile Contact Us''

On the instructor’s “Manage content” menu, one of the options is “Assignments”. Having “Assignments” appear in two places is potentially confusing. “Manage content > Assignments” allows the instructor to edit and create assignments, whereas the “Assignments” menu (that both students and instructors) see allows the instructor to participate in assignments.

Therefore, it makes sense to create a '''student view''' for instructors, which will enable them to see menu items that are only related to students. This will help resolve the confusion.

=== Problem statement ===
Create a '''student view''' for instructors. When in '''student view''', an instructor must not be able to view ''"Manage content"'' and ''"Survey Deployments"'' menu items, and must be able to switch back to the '''instructor view''' (the default view that an instructor first sees when he/she logs in). When in '''instructor view''', an instructor must not be able to view the ''"Assignment"'' and ''"Course Evaluation"'' menu items.

=== Team ===
# Akshay Ravichandran
# Krithika Sekhar
# Sameer Poudwal

'''Mentor''' - Dr. Ed Gehringer

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/views/menu_items/_suckerfish.html.erb ===
This file is responsible for rendering all menu items and their children (if any).

A condition was needed to check if the current menu item that is to be rendered is in the list of hidden menu items. The ''hidden_menu_items'' session variable holds the IDs of menu items that must not be rendered. This applies only when the type of user currently logged in is an instructor. Hence, the following condition was added.
<pre>
display_item_condition = (session[:user].role.instructor?)?(session[:hidden_menu_items].include?item_id)?false:true:true
</pre>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/app/helpers/menu_items_helper.rb ===

This is a helper for deciding what menu items must be hidden.
 The ''update_hidden_menu_items_for_student_view'' method is used to hide the ''Survey Deployments'' and ''Manage Instructor Content'' menu items. It does this by including the menu item IDs of these two menus in the ''hidden_menu_items'' session variable. (The ''hidden_menu_item'' variable will be used by _suckerfish.html.erb to decide whether or not to render a given menu item).
 Similarly, the ''update_hidden_menu_items_for_instructor_view'' method is used to hide the ''Assignments'' and ''Course Evaluation'' menu items.
 The ''set_hidden_menu_items'' method is used to set check if the given user is an instructor. If it is, then the ''update_hidden_menu_items_for_instructor_view'' method is called. This method is used to ensure that only those items that must be visible to an instructor view are visible to an instructor when he logs in for the first time. The method has been designed in this way because, in the future, other menu items may need to be hidden based on the user type.
<pre>
module MenuItemsHelper
# sets hidden_menu_items for the given user if
# user is an instructor. This method is needed to set
# the hidden_menu_items during initial login by instructor.
def self.set_hidden_menu_items(user, session)
if user.role.instructor?
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
else
session[:hidden_menu_items] = []
end
end

# updates hidden_menu_items in session object when an instructor is
# in student view
def self.update_hidden_menu_items_for_student_view(session)
# 35 - Survey Deployments, 37 - Manage Instructor Content
session[:hidden_menu_items] = [35, 37]
end

# updates hidden_menu_items in session object when an instructor is
# in instructor view
def self.update_hidden_menu_items_for_instructor_view(session)
# 26 - Assignments, 30 - Course Evaluation
session[:hidden_menu_items] = [26, 30]
end
end
</pre>

=== expertiza/app/controllers/auth_controller.rb ===
The ''after_login'' method in this controller sets up the session object after the user logs in, so it is a good candidate to include the initial set up of the ''hidden_menu_items'' session variable.

The following lines were added to the ''after_login'' method. This call is intended to set the 'hidden_menu_items' variable in the session object when an instructor logs in for the first time. This is done so that the instructor is by default in Instructor View when he logs in. (i.e ''Assignments'' and ''Course Evaluation'' are hidden).
<pre>
# hide menu items based on type of user
MenuItemsHelper.set_hidden_menu_items(user,session)
</pre>

The following lines were added to the ''clear_session'' method. These lines clear the ''student_view'' and ''hidden_menu_items'' session variables.
<pre>
session[:student_view] = nil
session[:hidden_menu_items] = nil
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
# Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.
# Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

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

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

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

RSpec Documentation
* http://rspec.info/documentation/

CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors

2018-03-25T23:06:51Z

Ksekhar: /* Testing */