Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:20:54Z

Sadhika2: /* Design - The Gruby Details */

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

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type.

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Database Changes===
There are no database changes as per the current design

===Files to be changed===
[[Image:Design_pic.png]]

==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After Instructor creates a conference type assignment, Author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:17:37Z

Sadhika2:

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

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type.

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Files to be changed===
[[Image:Design_pic.png]]
==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After Instructor creates a conference type assignment, Author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:16:51Z

Sadhika2: /* Changes for Conference's authors */

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

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

7. The role for both Author and Co-author is a student type.

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Files to be changed===
[[Image:Design_pic.png]]
==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After Instructor creates a conference type assignment, Author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:08:56Z

Sadhika2: /* Test Plan */

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

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Files to be changed===
[[Image:Design_pic.png]]
==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After Instructor creates a conference type assignment, Author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Co-author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team
*Test case to check if Co-author is added to Author's team

====Scenario 3: Conference type assignment being created ====
Instructor should be able to create conference type assignment

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Conference type assignment has been created

====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====
After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author/Co-author already have an account
*Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T04:01:44Z

Sadhika2: /* Test Plan */

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

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Problem Statement==

===Existing Solution===
Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.

===Proposed Solution===
This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.
The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.

==Task to be Accomplished==
* Instructor should be able to create new link for Authors to join the Conference Assignments
* Author should be able to create account by clicking on the link. If author doesnt have an account
* Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team.
* Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.

==Sequence Diagram==
[[File:SequenceDiagram.png]]

==Design - The Gruby Details==

===Creating The conference type assignment===

Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:

1. Instructor logs in with his credentials.

2. Instructor creates an assignment by checking a new check box - “Is conference style assignment”, to mark the assignment to be of conference type.

* This checkbox will be introduced in the Assignment’s edit page('''app/views/assignments/edit/_general.html''')

3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.

* If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.

The usage of the url and it’s working will be discussed in the next part.

===Changes for Conference's authors===

Following will be the high level steps the Author would be performing to create an account:

1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.

2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.

3. After Author account is created, the author can add co-authors to this assignments.

4. Author can login in and navigate to '''assignment -> Your Team''' and invite co-authors into his team for working on the submission.

5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.

6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.

===Changes for Conference's co-authors===

1. When a co-author click on the URL shared by author to join his team

* If co-author already has an account, he will be asked to login and will be able to view his team and assignment.
* If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.

2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.

===Files to be changed===
[[Image:Design_pic.png]]
==Test Plan==

Please find the below plan to test the functionality

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

====Scenario 1: Creating student type user from controller by bypassing admin approval ====
After Instructor creates a conference type assignment, Author should be able to create an account and this account doesn't require approval from admin.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Positive test case to check if author is able to to create and login into a new account without admin approval
*Negative test case to check author not able to login after account creation

====Scenario 2: Author after creating an account is able to access conference type assignment====
After Author has created an account, he/she should be able to access the conference type account.

Files associated with this functionality:
#users_controller_spec.rb

Following tests will be performed to verify whether the functionality is working as desired.
*Test case to check if Author is assigned to conference type assignment and able to access it
*Test case to check if Author has been added to default team

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj (bbhardw)

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-16T03:51:07Z

Sadhika2:

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T04:42:59Z

Sadhika2: /* Files to be changed */

File:Design pic.png

2019-11-12T04:42:42Z

Sadhika2:

File:Design new.png

2019-11-12T04:34:51Z

Sadhika2:

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T04:33:00Z

Sadhika2: /* Files to be changed */

File:Design.png

2019-11-12T04:32:25Z

Sadhika2: uploaded a new version of "File:Design.png"

File:FileChange.png

2019-11-12T04:30:13Z

Sadhika2:

File:File Changes.png

2019-11-12T04:25:39Z

Sadhika2:

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T04:22:32Z

Sadhika2: /* Files to be changed */

File:FileChanges.png

2019-11-12T04:21:55Z

Sadhika2:

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:51:16Z

Sadhika2: /* Changes for Conference's authors */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:44:26Z

Sadhika2: /* Design - The Gruby Details */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:41:40Z

Sadhika2: /* Changes for Conference's authors */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:36:34Z

Sadhika2: /* Changes for Conference's authors */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:31:59Z

Sadhika2: /* Creating The conference type assignment */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:31:16Z

Sadhika2: /* Problem Statement */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:28:51Z

Sadhika2: /* Problem Statement */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:27:52Z

Sadhika2: /* Changes for Conference's authors */

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-12T03:10:55Z

Sadhika2: /* Sequence Diagram */

File:SequenceDiagram.png

2019-11-12T03:10:26Z

Sadhika2:

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-11T19:04:35Z

Sadhika2:

==Introduction==
===About Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
Whenever someone is attending any seminar they have to submit their paper for it. Seminar is created as assignments in Expertiza backend. In today's scenario, participants just submit a google doc and share it with instructor. Then instructor has to download the paper and add it in expertiza assignment. Not only that, instructor has to create participants who is author or co- author in expertiza. All these things are done manually, which is not a good way.

===Task to be Accomplished===

* Instructor should be able to create new link for Authors to join the Seminar Assignments
* Author on clicking of link should be able to create account if not already present.
* Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team
* Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment

==Sequence Diagram==

[[File:Sequence.png]]

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj ()

File:Sequence.png

2019-11-11T19:03:19Z

Sadhika2:

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-11T19:02:52Z

Sadhika2:

==Introduction==
===About Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
Whenever someone is attending any seminar they have to submit their paper for it. Seminar is created as assignments in Expertiza backend. In today's scenario, participants just submit a google doc and share it with instructor. Then instructor has to download the paper and add it in expertiza assignment. Not only that, instructor has to create participants who is author or co- author in expertiza. All these things are done manually, which is not a good way.

===Task to be Accomplished===

* Instructor should be able to create new link for Authors to join the Seminar Assignments
* Author on clicking of link should be able to create account if not already present.
* Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team
* Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj ()

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-11T19:02:14Z

Sadhika2: /* Introduction */

==Introduction==
===About Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
Whenever someone is attending any seminar they have to submit their paper for it. Seminar is created as assignments in Expertiza backend. In today's scenario, participants just submit a google doc and share it with instructor. Then instructor has to download the paper and add it in expertiza assignment. Not only that, instructor has to create participants who is author or co- author in expertiza. All these things are done manually, which is not a good way.
The following tasks is to be accomplished in this project:

* Instructor should be able to create new link for Authors to join the Seminar Assignments
* Author on clicking of link should be able to create account if not already present.
* Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team
* Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment

===About Tagging===
Expertiza has a feature of peer review where other teams can provide feedback on student's work. There is also another feature of "Tags", where a student can answer if the feedback provided were helpful or not. Tags can vary from assignment to assignment but the main motive of it is to provide information on whether the feedback provides helpful information for student's assignment. The picture below shows an example of tags.

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj ()

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-11T18:59:25Z

Sadhika2: /* Introduction */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

==Introduction==
===About Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
The following tasks were accomplished in this project:

* If tagging is enabled, number of total tags per round is shown on student's score page
* Implemented feature which shows number of tags student have entered
* Implemented feature to show number of tags entered and total number of tags in Assignment page.
* Implemented feature to show tagging counts dynamically when student change tagging type in score page
* Added RSPEC testcases for testing changes done for tagging

===About Tagging===
Expertiza has a feature of peer review where other teams can provide feedback on student's work. There is also another feature of "Tags", where a student can answer if the feedback provided were helpful or not. Tags can vary from assignment to assignment but the main motive of it is to provide information on whether the feedback provides helpful information for student's assignment. The picture below shows an example of tags.

[[File:Example-tags.png]]

===Motivation===
For a particular assignment, there may be a lot of questions and hence multiple feedback. Students might miss a few tags and they might go unanswered. This feature will provide students to keep track of answered tags and show them how many tags have they answered out of total tags on the page.

==Design==
For counting, we are primarily concerned with two numbers: the number of possible tags for an assignment and the number of completed tags for an assignment. The latter is easy to calculate as it's directly stored as AnswerTags. The former is more difficult: possible tags are stored as TagPromptDeployments which do not have a 1:1 correspondence to the number of prompts the user sees on their page.

[[File:E1953_UML.png]]

The green classes are used to count the number of tags done, the red classes are used to count the number of tags possible, and the yellow classes are used to calculate both counts. All classes help to narrow the scope to a specific user and assignment.

==Implementation==

=== Task 1 : Count answered tags in an assignment on Assignment Homepage ===

==== Description ====
On clicking of particular Assignment, student can see his/her teams, work, scores, etc. There is no feature which allows student to show how many of the review tags has he/she answered on this page. This task implements this feature where student can see answered tags with respect to total tags in Assignment page.

==== Code Implemented ====
'''app/controllers/student_task_controller.rb'''
- The following code counts the number of Tags present in an assignment and total number of answered tags in that particular assignment.
<pre>
@completed_tags = 0
@total_tags = 0
vmlist.each do |vm|
vm.list_of_rows.each do |r|
r.score_row.each do |row|
vm_prompts = row.vm_prompts.select {|prompt| prompt.tag_dep.tag_prompt.control_type.downcase != "checkbox"}
@total_tags += vm_prompts.count
vm_prompts.each do |vm_prompt|
answer_tag = AnswerTag.where(tag_prompt_deployment_id: vm_prompt.tag_dep, user_id: @participant.user_id, answer: vm_prompt.answer).first
if !answer_tag.nil? and answer_tag.value != "0"
@completed_tags += 1
end
end
end
end
end
</pre>

=== Task 2 : Count answered tags in an assignment per rounds on Summary Report Page ===

==== Description ====
On clicking of particular Assignment>Your Scores> student can see his/her score. Student can also see all the reviews per rounds in particular assignment. This new feature will allow student to see number of answered tags per round with respect to number of total tags present in particular round

==== Code Implemented ====
'''app/controllers/grades_controller.rb'''
- The following code counts the number of Tags present in a round and total number of answered tags in that particular round.
<pre>
@vmlist.each do |vm|
if vm.round == @round
vm.list_of_rows.each do |r|
r.score_row.each do |row|
vm_prompts = row.vm_prompts.select {|prompt| prompt.tag_dep.tag_prompt.control_type.downcase != "checkbox"}
if vm_prompts.count > 0
@total_tags += vm_prompts.count
vm_prompts.each do |vm_prompt|
answer_tag = AnswerTag.where(tag_prompt_deployment_id: vm_prompt.tag_dep, user_id: @participant.user_id, answer: vm_prompt.answer).first
if !answer_tag.nil? and answer_tag.value != "0"
@completed_tags += 1
end
end
end
end
end
end
end
@total_tags_array.append(@total_tags)
@completed_tags_array.append(@completed_tags)
</pre>

=== Task 3 : Per round tag counts should be automatically updated as soon as tags are changed ===

==== Description ====
If a user changes their tags, the page formerly needed to be refreshed in order to display the correct counts. This functionality ensures that the tag counts always accurately reflect the results on the page.

==== Code Implemented ====
'''app/assets/javascripts/answer_tags.js'''
- The following code correctly increments/decrements the tag count on the page based on the user's action.
<pre>
update_tag_count = function(tag_prompt, round_number) {
//Get the previous value of this tag prompt from an HTML attribute
var old_value = tag_prompt.getAttribute('data-prev_value')
//This is the new value of the tag prompt
var new_value = tag_prompt.value
//Store the new value back into the HTML attribute
tag_prompt.setAttribute('data-prev_value', new_value)
//This is the current tag count for the round this tag is in
var current_count = parseInt(document.getElementById('tag_counts_' + (round_number)).innerHTML);
if(old_value != "0" && new_value == "0") {
//The user has reset the value of this tag. Decrement the tag count
document.getElementById('tag_counts_' + round_number).innerHTML = current_count - 1;
} else if(old_value == "0" && new_value != "0"){
//The user has set the value of this tag to something meaningful. Increment the count
document.getElementById('tag_counts_' + round_number).innerHTML = current_count + 1;
}
}
</pre>

==Process==
[[File:E1953_FlowChart2.png]]

==Test Plan==

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

===Issue 1: Show tagging count for Assignment Homepage===
====spec/controllers/student_task_controller_spec.rb====
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''
<pre>
it "reports zero completed tags correctly" do
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(0)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

'''Test Case 2'''
<pre>
it "reports some completed tags correctly" do
answer_tags = [AnswerTag.new(value: 0), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 1),
AnswerTag.new(value: 1), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 0),]

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([answer_tags[0]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([answer_tags[1]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([answer_tags[2]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([answer_tags[3]])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([answer_tags[4]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([answer_tags[5]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([answer_tags[6]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([answer_tags[7]])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(5)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

===Issue 2: Show tagging count for review page===
====spec/controllers/grades_controller_spec.rb====
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''
<pre>
it "reports zero completed tags correctly" do
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([])
params = {id: 1}
get :view_team, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(0)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

'''Test Case 2'''
<pre>
it "reports some completed tags correctly" do
answer_tags = [AnswerTag.new(value: 0), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 1),
AnswerTag.new(value: 1), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 0),]

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([answer_tags[0]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([answer_tags[1]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([answer_tags[2]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([answer_tags[3]])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([answer_tags[4]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([answer_tags[5]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([answer_tags[6]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([answer_tags[7]])
params = {id: 1}
get :view_team, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(5)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

=== Regression Tests ===
Since new changes were added to existing function, we ran the existing tests to ensure none of them were failing.

=== Manual Tests ===
We needed to check if the feature implemented were resulting the expected behavior. To test this we followed following steps:-

1. Login as a student

2. Select Assignment for Assignment Home Page

'''Test Case 1'''

This page should show number of tags completed and total tags present including all the rounds in that particular assignment. ✓

'''Test Case 2'''

On selecting Your Scores on Student Task page, Each round should show Review Tagged Column. ✓

'''Test Case 3'''

Review Tagged Column should consist of tags completed and total tags count for that particular round. ✓

'''Test Case 4'''

Review Tagged Column should not consist of tags completed in all rounds and total tags count. ✓

'''Test Case 5'''

Review Tagged Column should dynamically increase or decrease tag count when user change their tagging. ✓

==Deployed Example==
Below are instructions for navigating through expertiza to see the review tags in action.

'''1.''' Go to http://152.46.18.192:8080/ and log in as {username: student7552 password: password}.

'''2.''' After you log in if you are not at the assignments landing page (152.46.18.192:8080//student_task/list) click on Assignments to navigate there.

'''3.''' Click on "Final project (and design doc)" from the list of assignments in the table at the bottom of the page.

'''4.''' Behold the tag counter next to the bullet labeled "Your scores". It reads (You have tagged the available tags completed / total available reviews).

[[File:Assignment-page-tags.png]]

'''5'''. Further, click on "Your scores". On the next page that shows up, click on a row in the table to see the tags. Notice in the last column of the header of the table is a cell containing the available tags completed / total available tags.

[[FIle:Per-round-tags.png‎ ]]

'''6.''' After clicking on a row to reveal tags drag the blue square towards 'No,' 'Yes,' or the middle. Observe that the tags left / total tags has updated.

'''7.''' To observe the new per round tagging capabilities log out and then log in as {username: student8115 password: password}.

'''8.''' Select the first Program 2 from the list of assignments. In the next page click on "Your scores" as in step 4 above. Scroll down and behold tagging statistics for each round in the last column of the table headers.

[[FIle:Per-round-tagging2.png‎ ]]

==Teammates==
Mentor -Akanksha Mohan

* Sameer Adhikari (sadhika2)
* Spencer Yoder (smyoder)
* Mark Trawick (mtrawic)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-11T18:57:02Z

Sadhika2:

==Introduction==
===About Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
The following tasks is to be accomplished in this project:

* Instructor should be able to create new link for Authors to join the Seminar Assignments
* Author on clicking of link should be able to create account if not already present.
* Implemented feature to show number of tags entered and total number of tags in Assignment page.
* Implemented feature to show tagging counts dynamically when student change tagging type in score page
* Added RSPEC testcases for testing changes done for tagging

===About Tagging===
Expertiza has a feature of peer review where other teams can provide feedback on student's work. There is also another feature of "Tags", where a student can answer if the feedback provided were helpful or not. Tags can vary from assignment to assignment but the main motive of it is to provide information on whether the feedback provides helpful information for student's assignment. The picture below shows an example of tags.

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj ()

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-11T18:56:49Z

Sadhika2: /* Introduction */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

==Introduction==
===About Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
The following tasks is to be accomplished in this project:

* Implemented feature to show number of tags entered and total number of tags in Assignment page.
* Implemented feature to show tagging counts dynamically when student change tagging type in score page
* Added RSPEC testcases for testing changes done for tagging

===About Tagging===
Expertiza has a feature of peer review where other teams can provide feedback on student's work. There is also another feature of "Tags", where a student can answer if the feedback provided were helpful or not. Tags can vary from assignment to assignment but the main motive of it is to provide information on whether the feedback provides helpful information for student's assignment. The picture below shows an example of tags.

[[File:Example-tags.png]]

===Motivation===
For a particular assignment, there may be a lot of questions and hence multiple feedback. Students might miss a few tags and they might go unanswered. This feature will provide students to keep track of answered tags and show them how many tags have they answered out of total tags on the page.

==Design==
For counting, we are primarily concerned with two numbers: the number of possible tags for an assignment and the number of completed tags for an assignment. The latter is easy to calculate as it's directly stored as AnswerTags. The former is more difficult: possible tags are stored as TagPromptDeployments which do not have a 1:1 correspondence to the number of prompts the user sees on their page.

[[File:E1953_UML.png]]

The green classes are used to count the number of tags done, the red classes are used to count the number of tags possible, and the yellow classes are used to calculate both counts. All classes help to narrow the scope to a specific user and assignment.

==Implementation==

=== Task 1 : Count answered tags in an assignment on Assignment Homepage ===

==== Description ====
On clicking of particular Assignment, student can see his/her teams, work, scores, etc. There is no feature which allows student to show how many of the review tags has he/she answered on this page. This task implements this feature where student can see answered tags with respect to total tags in Assignment page.

==== Code Implemented ====
'''app/controllers/student_task_controller.rb'''
- The following code counts the number of Tags present in an assignment and total number of answered tags in that particular assignment.
<pre>
@completed_tags = 0
@total_tags = 0
vmlist.each do |vm|
vm.list_of_rows.each do |r|
r.score_row.each do |row|
vm_prompts = row.vm_prompts.select {|prompt| prompt.tag_dep.tag_prompt.control_type.downcase != "checkbox"}
@total_tags += vm_prompts.count
vm_prompts.each do |vm_prompt|
answer_tag = AnswerTag.where(tag_prompt_deployment_id: vm_prompt.tag_dep, user_id: @participant.user_id, answer: vm_prompt.answer).first
if !answer_tag.nil? and answer_tag.value != "0"
@completed_tags += 1
end
end
end
end
end
</pre>

=== Task 2 : Count answered tags in an assignment per rounds on Summary Report Page ===

==== Description ====
On clicking of particular Assignment>Your Scores> student can see his/her score. Student can also see all the reviews per rounds in particular assignment. This new feature will allow student to see number of answered tags per round with respect to number of total tags present in particular round

==== Code Implemented ====
'''app/controllers/grades_controller.rb'''
- The following code counts the number of Tags present in a round and total number of answered tags in that particular round.
<pre>
@vmlist.each do |vm|
if vm.round == @round
vm.list_of_rows.each do |r|
r.score_row.each do |row|
vm_prompts = row.vm_prompts.select {|prompt| prompt.tag_dep.tag_prompt.control_type.downcase != "checkbox"}
if vm_prompts.count > 0
@total_tags += vm_prompts.count
vm_prompts.each do |vm_prompt|
answer_tag = AnswerTag.where(tag_prompt_deployment_id: vm_prompt.tag_dep, user_id: @participant.user_id, answer: vm_prompt.answer).first
if !answer_tag.nil? and answer_tag.value != "0"
@completed_tags += 1
end
end
end
end
end
end
end
@total_tags_array.append(@total_tags)
@completed_tags_array.append(@completed_tags)
</pre>

=== Task 3 : Per round tag counts should be automatically updated as soon as tags are changed ===

==== Description ====
If a user changes their tags, the page formerly needed to be refreshed in order to display the correct counts. This functionality ensures that the tag counts always accurately reflect the results on the page.

==== Code Implemented ====
'''app/assets/javascripts/answer_tags.js'''
- The following code correctly increments/decrements the tag count on the page based on the user's action.
<pre>
update_tag_count = function(tag_prompt, round_number) {
//Get the previous value of this tag prompt from an HTML attribute
var old_value = tag_prompt.getAttribute('data-prev_value')
//This is the new value of the tag prompt
var new_value = tag_prompt.value
//Store the new value back into the HTML attribute
tag_prompt.setAttribute('data-prev_value', new_value)
//This is the current tag count for the round this tag is in
var current_count = parseInt(document.getElementById('tag_counts_' + (round_number)).innerHTML);
if(old_value != "0" && new_value == "0") {
//The user has reset the value of this tag. Decrement the tag count
document.getElementById('tag_counts_' + round_number).innerHTML = current_count - 1;
} else if(old_value == "0" && new_value != "0"){
//The user has set the value of this tag to something meaningful. Increment the count
document.getElementById('tag_counts_' + round_number).innerHTML = current_count + 1;
}
}
</pre>

==Process==
[[File:E1953_FlowChart2.png]]

==Test Plan==

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

===Issue 1: Show tagging count for Assignment Homepage===
====spec/controllers/student_task_controller_spec.rb====
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''
<pre>
it "reports zero completed tags correctly" do
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(0)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

'''Test Case 2'''
<pre>
it "reports some completed tags correctly" do
answer_tags = [AnswerTag.new(value: 0), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 1),
AnswerTag.new(value: 1), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 0),]

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([answer_tags[0]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([answer_tags[1]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([answer_tags[2]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([answer_tags[3]])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([answer_tags[4]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([answer_tags[5]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([answer_tags[6]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([answer_tags[7]])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(5)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

===Issue 2: Show tagging count for review page===
====spec/controllers/grades_controller_spec.rb====
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''
<pre>
it "reports zero completed tags correctly" do
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([])
params = {id: 1}
get :view_team, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(0)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

'''Test Case 2'''
<pre>
it "reports some completed tags correctly" do
answer_tags = [AnswerTag.new(value: 0), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 1),
AnswerTag.new(value: 1), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 0),]

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([answer_tags[0]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([answer_tags[1]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([answer_tags[2]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([answer_tags[3]])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([answer_tags[4]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([answer_tags[5]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([answer_tags[6]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([answer_tags[7]])
params = {id: 1}
get :view_team, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(5)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

=== Regression Tests ===
Since new changes were added to existing function, we ran the existing tests to ensure none of them were failing.

=== Manual Tests ===
We needed to check if the feature implemented were resulting the expected behavior. To test this we followed following steps:-

1. Login as a student

2. Select Assignment for Assignment Home Page

'''Test Case 1'''

This page should show number of tags completed and total tags present including all the rounds in that particular assignment. ✓

'''Test Case 2'''

On selecting Your Scores on Student Task page, Each round should show Review Tagged Column. ✓

'''Test Case 3'''

Review Tagged Column should consist of tags completed and total tags count for that particular round. ✓

'''Test Case 4'''

Review Tagged Column should not consist of tags completed in all rounds and total tags count. ✓

'''Test Case 5'''

Review Tagged Column should dynamically increase or decrease tag count when user change their tagging. ✓

==Deployed Example==
Below are instructions for navigating through expertiza to see the review tags in action.

'''1.''' Go to http://152.46.18.192:8080/ and log in as {username: student7552 password: password}.

'''2.''' After you log in if you are not at the assignments landing page (152.46.18.192:8080//student_task/list) click on Assignments to navigate there.

'''3.''' Click on "Final project (and design doc)" from the list of assignments in the table at the bottom of the page.

'''4.''' Behold the tag counter next to the bullet labeled "Your scores". It reads (You have tagged the available tags completed / total available reviews).

[[File:Assignment-page-tags.png]]

'''5'''. Further, click on "Your scores". On the next page that shows up, click on a row in the table to see the tags. Notice in the last column of the header of the table is a cell containing the available tags completed / total available tags.

[[FIle:Per-round-tags.png‎ ]]

'''6.''' After clicking on a row to reveal tags drag the blue square towards 'No,' 'Yes,' or the middle. Observe that the tags left / total tags has updated.

'''7.''' To observe the new per round tagging capabilities log out and then log in as {username: student8115 password: password}.

'''8.''' Select the first Program 2 from the list of assignments. In the next page click on "Your scores" as in step 4 above. Scroll down and behold tagging statistics for each round in the last column of the table headers.

[[FIle:Per-round-tagging2.png‎ ]]

==Teammates==
Mentor -Akanksha Mohan

* Sameer Adhikari (sadhika2)
* Spencer Yoder (smyoder)
* Mark Trawick (mtrawic)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-11T18:56:20Z

Sadhika2: /* Introduction */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

==Introduction==
===About Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
The following tasks is to be accomplished in this project:

* Instructor should be able to create new link for Authors to join the Seminar Assignments
* Author on clicking of link should be able to create account if not already present.
* Implemented feature to show number of tags entered and total number of tags in Assignment page.
* Implemented feature to show tagging counts dynamically when student change tagging type in score page
* Added RSPEC testcases for testing changes done for tagging

===About Tagging===
Expertiza has a feature of peer review where other teams can provide feedback on student's work. There is also another feature of "Tags", where a student can answer if the feedback provided were helpful or not. Tags can vary from assignment to assignment but the main motive of it is to provide information on whether the feedback provides helpful information for student's assignment. The picture below shows an example of tags.

[[File:Example-tags.png]]

===Motivation===
For a particular assignment, there may be a lot of questions and hence multiple feedback. Students might miss a few tags and they might go unanswered. This feature will provide students to keep track of answered tags and show them how many tags have they answered out of total tags on the page.

==Design==
For counting, we are primarily concerned with two numbers: the number of possible tags for an assignment and the number of completed tags for an assignment. The latter is easy to calculate as it's directly stored as AnswerTags. The former is more difficult: possible tags are stored as TagPromptDeployments which do not have a 1:1 correspondence to the number of prompts the user sees on their page.

[[File:E1953_UML.png]]

The green classes are used to count the number of tags done, the red classes are used to count the number of tags possible, and the yellow classes are used to calculate both counts. All classes help to narrow the scope to a specific user and assignment.

==Implementation==

=== Task 1 : Count answered tags in an assignment on Assignment Homepage ===

==== Description ====
On clicking of particular Assignment, student can see his/her teams, work, scores, etc. There is no feature which allows student to show how many of the review tags has he/she answered on this page. This task implements this feature where student can see answered tags with respect to total tags in Assignment page.

==== Code Implemented ====
'''app/controllers/student_task_controller.rb'''
- The following code counts the number of Tags present in an assignment and total number of answered tags in that particular assignment.
<pre>
@completed_tags = 0
@total_tags = 0
vmlist.each do |vm|
vm.list_of_rows.each do |r|
r.score_row.each do |row|
vm_prompts = row.vm_prompts.select {|prompt| prompt.tag_dep.tag_prompt.control_type.downcase != "checkbox"}
@total_tags += vm_prompts.count
vm_prompts.each do |vm_prompt|
answer_tag = AnswerTag.where(tag_prompt_deployment_id: vm_prompt.tag_dep, user_id: @participant.user_id, answer: vm_prompt.answer).first
if !answer_tag.nil? and answer_tag.value != "0"
@completed_tags += 1
end
end
end
end
end
</pre>

=== Task 2 : Count answered tags in an assignment per rounds on Summary Report Page ===

==== Description ====
On clicking of particular Assignment>Your Scores> student can see his/her score. Student can also see all the reviews per rounds in particular assignment. This new feature will allow student to see number of answered tags per round with respect to number of total tags present in particular round

==== Code Implemented ====
'''app/controllers/grades_controller.rb'''
- The following code counts the number of Tags present in a round and total number of answered tags in that particular round.
<pre>
@vmlist.each do |vm|
if vm.round == @round
vm.list_of_rows.each do |r|
r.score_row.each do |row|
vm_prompts = row.vm_prompts.select {|prompt| prompt.tag_dep.tag_prompt.control_type.downcase != "checkbox"}
if vm_prompts.count > 0
@total_tags += vm_prompts.count
vm_prompts.each do |vm_prompt|
answer_tag = AnswerTag.where(tag_prompt_deployment_id: vm_prompt.tag_dep, user_id: @participant.user_id, answer: vm_prompt.answer).first
if !answer_tag.nil? and answer_tag.value != "0"
@completed_tags += 1
end
end
end
end
end
end
end
@total_tags_array.append(@total_tags)
@completed_tags_array.append(@completed_tags)
</pre>

=== Task 3 : Per round tag counts should be automatically updated as soon as tags are changed ===

==== Description ====
If a user changes their tags, the page formerly needed to be refreshed in order to display the correct counts. This functionality ensures that the tag counts always accurately reflect the results on the page.

==== Code Implemented ====
'''app/assets/javascripts/answer_tags.js'''
- The following code correctly increments/decrements the tag count on the page based on the user's action.
<pre>
update_tag_count = function(tag_prompt, round_number) {
//Get the previous value of this tag prompt from an HTML attribute
var old_value = tag_prompt.getAttribute('data-prev_value')
//This is the new value of the tag prompt
var new_value = tag_prompt.value
//Store the new value back into the HTML attribute
tag_prompt.setAttribute('data-prev_value', new_value)
//This is the current tag count for the round this tag is in
var current_count = parseInt(document.getElementById('tag_counts_' + (round_number)).innerHTML);
if(old_value != "0" && new_value == "0") {
//The user has reset the value of this tag. Decrement the tag count
document.getElementById('tag_counts_' + round_number).innerHTML = current_count - 1;
} else if(old_value == "0" && new_value != "0"){
//The user has set the value of this tag to something meaningful. Increment the count
document.getElementById('tag_counts_' + round_number).innerHTML = current_count + 1;
}
}
</pre>

==Process==
[[File:E1953_FlowChart2.png]]

==Test Plan==

=== RSpec Tests ===
Please find below RSpec Test cases for this feature

===Issue 1: Show tagging count for Assignment Homepage===
====spec/controllers/student_task_controller_spec.rb====
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''
<pre>
it "reports zero completed tags correctly" do
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(0)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

'''Test Case 2'''
<pre>
it "reports some completed tags correctly" do
answer_tags = [AnswerTag.new(value: 0), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 1),
AnswerTag.new(value: 1), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 0),]

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([answer_tags[0]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([answer_tags[1]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([answer_tags[2]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([answer_tags[3]])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([answer_tags[4]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([answer_tags[5]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([answer_tags[6]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([answer_tags[7]])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(5)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

===Issue 2: Show tagging count for review page===
====spec/controllers/grades_controller_spec.rb====
Follow the below steps to Verify the fix for this issue:

'''Test Case 1'''
<pre>
it "reports zero completed tags correctly" do
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([])
params = {id: 1}
get :view_team, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(0)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

'''Test Case 2'''
<pre>
it "reports some completed tags correctly" do
answer_tags = [AnswerTag.new(value: 0), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 1),
AnswerTag.new(value: 1), AnswerTag.new(value: 1), AnswerTag.new(value: -1), AnswerTag.new(value: 0),]

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer2).and_return([answer_tags[0]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer2).and_return([answer_tags[1]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer2).and_return([answer_tags[2]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer2).and_return([answer_tags[3]])

allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment1, user_id: 1, answer: answer1).and_return([answer_tags[4]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment2, user_id: 1, answer: answer1).and_return([answer_tags[5]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment3, user_id: 1, answer: answer1).and_return([answer_tags[6]])
allow(AnswerTag).to receive(:where).with(tag_prompt_deployment_id: deployment4, user_id: 1, answer: answer1).and_return([answer_tags[7]])
params = {id: 1}
get :view_team, params
expect(controller.instance_variable_get(:@participant)).to eq(participant)
expect(assigns(:completed_tags)).to eq(5)
expect(assigns(:total_tags)).to eq(6)
end
</pre>

=== Regression Tests ===
Since new changes were added to existing function, we ran the existing tests to ensure none of them were failing.

=== Manual Tests ===
We needed to check if the feature implemented were resulting the expected behavior. To test this we followed following steps:-

1. Login as a student

2. Select Assignment for Assignment Home Page

'''Test Case 1'''

This page should show number of tags completed and total tags present including all the rounds in that particular assignment. ✓

'''Test Case 2'''

On selecting Your Scores on Student Task page, Each round should show Review Tagged Column. ✓

'''Test Case 3'''

Review Tagged Column should consist of tags completed and total tags count for that particular round. ✓

'''Test Case 4'''

Review Tagged Column should not consist of tags completed in all rounds and total tags count. ✓

'''Test Case 5'''

Review Tagged Column should dynamically increase or decrease tag count when user change their tagging. ✓

==Deployed Example==
Below are instructions for navigating through expertiza to see the review tags in action.

'''1.''' Go to http://152.46.18.192:8080/ and log in as {username: student7552 password: password}.

'''2.''' After you log in if you are not at the assignments landing page (152.46.18.192:8080//student_task/list) click on Assignments to navigate there.

'''3.''' Click on "Final project (and design doc)" from the list of assignments in the table at the bottom of the page.

'''4.''' Behold the tag counter next to the bullet labeled "Your scores". It reads (You have tagged the available tags completed / total available reviews).

[[File:Assignment-page-tags.png]]

'''5'''. Further, click on "Your scores". On the next page that shows up, click on a row in the table to see the tags. Notice in the last column of the header of the table is a cell containing the available tags completed / total available tags.

[[FIle:Per-round-tags.png‎ ]]

'''6.''' After clicking on a row to reveal tags drag the blue square towards 'No,' 'Yes,' or the middle. Observe that the tags left / total tags has updated.

'''7.''' To observe the new per round tagging capabilities log out and then log in as {username: student8115 password: password}.

'''8.''' Select the first Program 2 from the list of assignments. In the next page click on "Your scores" as in step 4 above. Scroll down and behold tagging statistics for each round in the last column of the table headers.

[[FIle:Per-round-tagging2.png‎ ]]

==Teammates==
Mentor -Akanksha Mohan

* Sameer Adhikari (sadhika2)
* Spencer Yoder (smyoder)
* Mark Trawick (mtrawic)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Fall 2019

2019-11-11T18:52:16Z

Sadhika2:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - Project E1943. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1953. Tagging report for student]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]
* [[CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names]]
* [[CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management]]
* [[CSC/ECE 517 Fall 2019 - E1948. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams]]
* [[CSC/ECE 517 Fall 2019 - E1969. Fixes for reviews not being available]]
* [[CSC/ECE 517 Fall 2019 - E1951. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2019 - E1957. Time travel Not Allowed..!!! Restrict TAs’ ability to change their own grade + limit file-size upload]]
* [[CSC/ECE 517 Fall 2019 - E1963. Changing assignment participant role]]
* [[CSC/ECE 517 Fall 2019 - E1941. Issues related to topic deadlines]]
* [[CSC/ECE 517 Fall 2019 - E1966. Tabbed_reviews partial file refactor for displaying the alternate view of reviews]]
* [[CSC/ECE 517 Fall 2019 - E1962. Email notification upon account creation]]
* [[CSC/ECE 517 Fall 2019 - E1967. Fix glitches in author feedback]]
* [[CSC/ECE 517 Fall 2019 - E1960. Create new late policy successfully and fixing "Back" link]]
* [[CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements]]
* [[CSC/ECE 517 Fall 2019 - M1950. Support Asynchronous Web Assembly Compilation]]
* [[CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews]]
* [[CSC/ECE 517 Fall 2019 - M1951. Implement missing OffscreenCanvas APIs]]
* [[CSC/ECE 517 Fall 2019 - E1940. Improving email notification]]
* [[CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug]]
* [[CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb]]
* [[CSC/ECE 517 Fall 2019 - M1952. Missing DOM features project]]
* [[CSC/ECE 517 Fall 2019 - E1945. Refactor users_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1964. Export review scores for projects]]
* [[CSC/ECE 517 Fall 2019 - E1949. Write Unit Tests for Importing assignment participants and import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1944. Refactor review mapping controller]]
* [[CSC/ECE 517 Fall 2019 - E1946. Refactor Questionnaire controller]]
* [[CSC/ECE 517 Fall 2019 - E1982. Regulate changing of rubrics while projects are in progress]]
* [[CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions]]
* [[CSC/ECE 517 Fall 2019 - E1990. Integrate suggestion detection algorithm]]
* [[CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality]]
* [[CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]]
* [[CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view]]
* [[CSC/ECE 517 Fall 2019 - E1995. Weights in grade calculation]]
* [[CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.]]
* [[CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades]]
* [[CSC/ECE 517 Fall 2019 - E1994. Mentor management for assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing]]
* [[CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric]]
* [[CSC/ECE 517 Fall 2019 - E1996. Enhancements to review grader]]
* [[CSC/ECE 517 Fall 2019 - E1987. Improving search facility in Expertiza]]
* [[CSC/ECE 517 Fall 2019 - E1978. Fix issues related to deadlines and late policies]]
* [[CSC/ECE 517 Fall 2019 - E1991. Improvements to anonymized view]]
* [[CSC/ECE 517 Fall 2019 - E1998. Weights in grade calculation]]
* [[CSC/ECE 517 Fall 2019 - E1986. Allow reviewers to bid on what to review]]
* [[CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design]]

CSC/ECE 517 Fall 2019 -E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-11T18:51:40Z

Sadhika2: Created page with "==Teammates== Mentor - Prof. Edward Gehringer * Sameer Adhikari (sadhika2) * Gurman Singh (gsingh23) * Garima Garima (ggarima) * Bharat Bhardwaj ()"

==Teammates==

Mentor - Prof. Edward Gehringer

* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj ()

E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-11T18:51:30Z

Sadhika2: /* Teammates */

E1974 Allow users to create an account and submit work to an ”assignment” Design

2019-11-11T18:49:13Z

Sadhika2: Created page with "==Teammates== Mentor - Prof. Edward Gehringer * Sameer Adhikari (sadhika2) * Gurman Singh (gsingh23) * Garima Garima (ggarima) * Bharat Bhardwaj ()"

==Teammates==
Mentor - Prof. Edward Gehringer
* Sameer Adhikari (sadhika2)
* Gurman Singh (gsingh23)
* Garima Garima (ggarima)
* Bharat Bhardwaj ()

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-07T03:45:33Z

Sadhika2: /* Test Plan */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-06T22:18:25Z

Sadhika2: /* Test Plan */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-06T21:21:31Z

Sadhika2: /* Manual Tests */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-06T21:20:32Z

Sadhika2: /* Test Plan */

File:Tick.png

2019-11-06T21:10:13Z

Sadhika2:

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-06T21:07:39Z

Sadhika2: /* Test Plan */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-11-06T20:48:30Z

Sadhika2:

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-10-29T01:22:32Z

Sadhika2: /* Task 2 : Count answered tags in an assignment per rounds on Scores Homepage */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-10-29T01:21:46Z

Sadhika2: /* Implementation */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-10-28T20:07:50Z

Sadhika2: /* FlowChart */

CSC/ECE 517 Fall 2019 - E1953. Tagging report for student

2019-10-28T18:02:24Z

Sadhika2:

File:E1953 FlowChart2.png

2019-10-28T18:02:05Z

Sadhika2:

File:E1953 FlowChart1.png

2019-10-28T17:59:17Z

Sadhika2: