Expertiza_Wiki - User contributions [en]

File:StudentTeamsView.png

2019-12-07T17:43:21Z

Srachak: uploaded a new version of "File:StudentTeamsView.png"

File:StudentTeamsView.png

2019-12-07T17:40:39Z

Srachak: uploaded a new version of "File:StudentTeamsView.png"

File:StudentTeamsView.png

2019-12-07T17:36:31Z

Srachak:

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T17:36:12Z

Srachak: /* Implementation */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Implementation==
A new class Cake has been newly introduced as a subclass of ScoredQuestion. The Cake class is a type of question that can be offered as part of any questionnaire, which keeps an account of all the answer values recorded for one specific question. The maximum value that can be given to a question of type cake is 100, and any value entered above 100 is automatically void, setting the answer entered to zero by default. The user is informed of the same and also can keep track of how much of the “cake” has already been taken, which helps him determine the value that he can enter. Upon entering a value greater than 100, a warning is displayed, informing the user that the value has exceeded 100, and setting the value back to 0. A textbox input with up-down arrows is being used, to help the user increment/decrement values as he pleases.

The general makeup in expertiza for different type of questions is that each question has the following methods:
edit(_count)
View_question_text
complete()
view_completed_question()

The parameters for the last two methods - complete and view_completed_question vary, depending on the type of question. These methods are responsible for rendering html code onto the view in which they are being referenced. Similarly, the following methods have been added to cake.rb :

edit(_count)
[[File:EditCake.png|center]]
The edit method is called on the initial questionnaire creation, and the view on the browser is as shown below:
[[File:EditCake1.png|center]]
The method is invoked from the questionnaire/edit.html.erb file.

View_question_text
The following code has been added to this method:
[[File:ViewQuestion.png|center]]
The method is invoked from the view questionnaire option (questionnaire/view.html.erb), on each questionnaire, showing the text for the question, type (being cake) and weight (default 1).

view_completed_question()
Snippet of the code is shown below:
[[File:ViewCompletedQuestion.png|center]]
The method is called when the user/participant wants to view or review his/her. The screen for the same when a cake type question is added to the teammate review is as shown below:
[[File:ViewCompletedQuestion1.png|center]]
The cake type question will always have a green circle in the background, rending the score on top of it. The method is called from the response/view.html.erb file.

In order to enable a student to review him/herself as a teammate we have implemented self reviews for teammate assessment. We have incorporated a checkbox in the review strategy tab of creating/ editing an assignment which will allow the instructor to either enable or disable this feature. We added the following code to '''assignments/edit/_review_strategy.html.erb''' file as follows:
[[File:SelfReviewCode.png|center]]

We also included a warning for the instructor, incase they try to enable self teammate reviews after creating the assignment and after some of the students have given their reviews. Since, enabling this feature would cause inconsistencies in data with respect to cake. For example: In teammate review assessment, let there be a cake type question about the amount of contribution provided by each team member. Previously, the cake should be split between all the other team members apart from the author. After enabling self reviews, cake has to include the author as well.
The warning is implemented as follows:
[[File:SelfReviewCode2.png|center]]

#Edited '''student_teams/view.html.erb''' to add reviewer to list of displayed teammates and show review link if self review is enabled
[[File:StudentTeamsView.png|center]]

'''Other Changes'''
#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T17:17:31Z

Srachak: /* Notable Code changes */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Implementation==
A new class Cake has been newly introduced as a subclass of ScoredQuestion. The Cake class is a type of question that can be offered as part of any questionnaire, which keeps an account of all the answer values recorded for one specific question. The maximum value that can be given to a question of type cake is 100, and any value entered above 100 is automatically void, setting the answer entered to zero by default. The user is informed of the same and also can keep track of how much of the “cake” has already been taken, which helps him determine the value that he can enter. Upon entering a value greater than 100, a warning is displayed, informing the user that the value has exceeded 100, and setting the value back to 0. A textbox input with up-down arrows is being used, to help the user increment/decrement values as he pleases.

The general makeup in expertiza for different type of questions is that each question has the following methods:
edit(_count)
View_question_text
complete()
view_completed_question()

The parameters for the last two methods - complete and view_completed_question vary, depending on the type of question. These methods are responsible for rendering html code onto the view in which they are being referenced. Similarly, the following methods have been added to cake.rb :

edit(_count)
[[File:EditCake.png|center]]
The edit method is called on the initial questionnaire creation, and the view on the browser is as shown below:
[[File:EditCake1.png|center]]
The method is invoked from the questionnaire/edit.html.erb file.

View_question_text
The following code has been added to this method:
[[File:ViewQuestion.png|center]]
The method is invoked from the view questionnaire option (questionnaire/view.html.erb), on each questionnaire, showing the text for the question, type (being cake) and weight (default 1).

view_completed_question()
Snippet of the code is shown below:
[[File:ViewCompletedQuestion.png|center]]
The method is called when the user/participant wants to view or review his/her. The screen for the same when a cake type question is added to the teammate review is as shown below:
[[File:ViewCompletedQuestion1.png|center]]
The cake type question will always have a green circle in the background, rending the score on top of it. The method is called from the response/view.html.erb file.

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' to add ‘Add self to teammate review’ to the list of options:
[[File:SelfReviewCode.png|center]]
Warn the instructor when they enable self reviews after students have started giving reviews
[[File:SelfReviewCode2.png|center]]
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T17:17:18Z

Srachak: /* Design & Implementation */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Notable Code changes==
A new class Cake has been newly introduced as a subclass of ScoredQuestion. The Cake class is a type of question that can be offered as part of any questionnaire, which keeps an account of all the answer values recorded for one specific question. The maximum value that can be given to a question of type cake is 100, and any value entered above 100 is automatically void, setting the answer entered to zero by default. The user is informed of the same and also can keep track of how much of the “cake” has already been taken, which helps him determine the value that he can enter. Upon entering a value greater than 100, a warning is displayed, informing the user that the value has exceeded 100, and setting the value back to 0. A textbox input with up-down arrows is being used, to help the user increment/decrement values as he pleases.

The general makeup in expertiza for different type of questions is that each question has the following methods:
edit(_count)
View_question_text
complete()
view_completed_question()

The parameters for the last two methods - complete and view_completed_question vary, depending on the type of question. These methods are responsible for rendering html code onto the view in which they are being referenced. Similarly, the following methods have been added to cake.rb :

edit(_count)
[[File:EditCake.png|center]]
The edit method is called on the initial questionnaire creation, and the view on the browser is as shown below:
[[File:EditCake1.png|center]]
The method is invoked from the questionnaire/edit.html.erb file.

View_question_text
The following code has been added to this method:
[[File:ViewQuestion.png|center]]
The method is invoked from the view questionnaire option (questionnaire/view.html.erb), on each questionnaire, showing the text for the question, type (being cake) and weight (default 1).

view_completed_question()
Snippet of the code is shown below:
[[File:ViewCompletedQuestion.png|center]]
The method is called when the user/participant wants to view or review his/her. The screen for the same when a cake type question is added to the teammate review is as shown below:
[[File:ViewCompletedQuestion1.png|center]]
The cake type question will always have a green circle in the background, rending the score on top of it. The method is called from the response/view.html.erb file.

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' to add ‘Add self to teammate review’ to the list of options:
[[File:SelfReviewCode.png|center]]
Warn the instructor when they enable self reviews after students have started giving reviews
[[File:SelfReviewCode2.png|center]]
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

File:ViewCompletedQuestion1.png

2019-12-07T16:47:28Z

Srachak: uploaded a new version of "File:ViewCompletedQuestion1.png"

File:ViewCompletedQuestion.png

2019-12-07T16:47:16Z

Srachak: uploaded a new version of "File:ViewCompletedQuestion.png"

view cmp

File:ViewQuestion.png

2019-12-07T16:47:03Z

Srachak: uploaded a new version of "File:ViewQuestion.png"

view q

File:EditCake1.png

2019-12-07T16:41:46Z

Srachak: uploaded a new version of "File:EditCake1.png"

edit 2

File:EditCake.png

2019-12-07T16:41:19Z

Srachak: uploaded a new version of "File:EditCake.png"

editcake

File:SelfReviewCode2.png

2019-12-07T16:38:20Z

Srachak:

File:SelfReviewCode.png

2019-12-07T16:38:01Z

Srachak:

File:ViewCompletedQuestion1.png

2019-12-07T16:37:44Z

Srachak:

File:ViewCompletedQuestion.png

2019-12-07T16:37:13Z

Srachak: view cmp

view cmp

File:ViewQuestion.png

2019-12-07T16:36:52Z

Srachak: view q

view q

File:EditCake1.png

2019-12-07T16:36:24Z

Srachak: edit 2

edit 2

File:EditCake.png

2019-12-07T16:36:09Z

Srachak: editcake

editcake

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T16:29:07Z

Srachak: /* Files Modified in the Project */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design & Implementation==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Notable Code changes==
A new class Cake has been newly introduced as a subclass of ScoredQuestion. The Cake class is a type of question that can be offered as part of any questionnaire, which keeps an account of all the answer values recorded for one specific question. The maximum value that can be given to a question of type cake is 100, and any value entered above 100 is automatically void, setting the answer entered to zero by default. The user is informed of the same and also can keep track of how much of the “cake” has already been taken, which helps him determine the value that he can enter. Upon entering a value greater than 100, a warning is displayed, informing the user that the value has exceeded 100, and setting the value back to 0. A textbox input with up-down arrows is being used, to help the user increment/decrement values as he pleases.

The general makeup in expertiza for different type of questions is that each question has the following methods:
edit(_count)
View_question_text
complete()
view_completed_question()

The parameters for the last two methods - complete and view_completed_question vary, depending on the type of question. These methods are responsible for rendering html code onto the view in which they are being referenced. Similarly, the following methods have been added to cake.rb :

edit(_count)
[[File:EditCake.png|center]]
The edit method is called on the initial questionnaire creation, and the view on the browser is as shown below:
[[File:EditCake1.png|center]]
The method is invoked from the questionnaire/edit.html.erb file.

View_question_text
The following code has been added to this method:
[[File:ViewQuestion.png|center]]
The method is invoked from the view questionnaire option (questionnaire/view.html.erb), on each questionnaire, showing the text for the question, type (being cake) and weight (default 1).

view_completed_question()
Snippet of the code is shown below:
[[File:ViewCompletedQuestion.png|center]]
The method is called when the user/participant wants to view or review his/her. The screen for the same when a cake type question is added to the teammate review is as shown below:
[[File:ViewCompletedQuestion1.png|center]]
The cake type question will always have a green circle in the background, rending the score on top of it. The method is called from the response/view.html.erb file.

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' to add ‘Add self to teammate review’ to the list of options:
[[File:SelfReviewCode.png|center]]
Warn the instructor when they enable self reviews after students have started giving reviews
[[File:SelfReviewCode2.png|center]]
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T16:20:49Z

Srachak: /* Proposed Solution: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design & Implementation==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T16:19:39Z

Srachak: /* Why we chose this approach */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design & Implementation==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T15:07:03Z

Srachak: /* UI Testing */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design & Implementation==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T14:59:50Z

Srachak: /* Proposed Solution: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design & Implementation==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg|center]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T14:59:29Z

Srachak: /* Why we chose this approach */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design & Implementation==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

===Why we chose this approach===
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

File:ReviewReport.png

2019-12-07T14:58:57Z

Srachak: uploaded a new version of "File:ReviewReport.png": hello

Report for self review and teammate review

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T14:58:23Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Design & Implementation==
===Proposed Solution:===

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

==Why we chose this approach==
The initial idea for this project was to make use of the existing feature for self-review, when a team member reviews his/her contribution to the team. But after considering code that also involves teammate reviews, what we have observed is that every assignment has the option to render reports to the instructor - showcasing different types of reports such as Review Reports, Teammate Review Reports, Self Review Reports, Answer Tagging reports. If the existing self-review feature were to be implemented, the view for the Self Review reports would also contain self-teammate reviews, which would cause inconsistencies in rendering Self Review Reports, and does not help serve the purpose of a legible report.

Thus, keeping self-teammate reviews as an instance of TeammateReview would help the instructor in evaluating all the reviews in one go, as the view that gets rendered is shown below:
[[File:ReviewReport.png|center]]
Here, for simplicity, the assignment - Assignment_Example can have teams with maximum of 2 participants. Consider Student8529, who has reviewed himself and his teammate Student8663. With the design approach taken for this project, when Student8529 reviews himself, the review would appear under the Teammate reviewed, under the Teammate review report. This would certainly help instructors verify reviews in a much simpler manner. The design also ensures minimal code change to existing code.

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

File:Testing2.png

2019-12-07T14:52:35Z

Srachak: uploaded a new version of "File:Testing2.png": hi

Testing2

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T14:51:33Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:
[[File:Testing2.png|center]]

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

File:ReviewReport.png

2019-12-07T14:51:03Z

Srachak: Report for self review and teammate review

Report for self review and teammate review

File:Testing2.png

2019-12-07T14:49:57Z

Srachak: Testing2

Testing2

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T14:49:09Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:Database.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder. The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.
[[File:Testing1.png|center]]

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

File:Testing1.png

2019-12-07T14:47:13Z

Srachak: uploaded a new version of "File:Testing1.png": Testing code

testcase code1

File:Testing1.png

2019-12-07T14:41:21Z

Srachak: uploaded a new version of "File:Testing1.png": Testing code

testcase code1

File:Testing1.png

2019-12-07T14:39:01Z

Srachak: testcase code1

testcase code1

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T03:18:09Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:ER2.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

Both Rspec and Capybara with Rspec tests have been written, with the capybara file - cake_questionnaire.rb added to spec/features folder, and rspec model file - cake_spec.rb added to the spec/models folder.

The capybara test creates a new questionnaire by logging into expertiza as instructor6, and adds the cake type questions to the questionnaire.

Several other test cases such as successful login into expertiza, along with testing the two main scenarios (shown in the snippet above) had been tested. The question_type is a list of values which contain all types of questions, which includes the question type cake. The test cases pass, on creation of a review questionnaire and on creation of a questionnaire with different types of questions, including the cake type questions to the questionnaire rubric.

The RSpec testing has been done on the cake.rb model, and has resulted in a decent code coverage of 82.73% and sample code can be seen in the snippet below:

With most of the code on the model is rendering html code, the correctness of the html code has been tested, to check if rspec also results in code that is expected.
To run and verify Rspec results, please do run the following commands from the expertiza folder:

rspec spec/models/cake_spec.rb
rspec spec/features/cake_questionnaire.rb

With the right gems installed, the test cases should ideally pass.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-07T03:15:35Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. Students can form teams in expertiza to work on an assignment in a group. A student team can submit their work through multiple means such as file uploads and embedded links. Expertiza also consists of questionnaires which can be leveraged for many tasks one of them being peer evaluation of submissions. Students can also review their teammates, making use of the teammate review questionnaire, based on their contribution to the projects.

==Problem Definition:==

Expertiza rubrics are utilized to build questionnaires and these rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. When we use these questionnaires for reviews, for example the teammate review assessment we encounter a few problems. One “problem” with all of these types is that there is nothing to stop a reviewer (say some student) from assigning the maximum score to all the reviewees (student's teammates). This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Files Modified in the Project==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

==Database Modification==
In order to implement the self review feature for teammate reviews we have added a column "is_self_teammate_review_enabled" to the assignments table. Below is the migration for the same:

<pre> class SelfTeammateReview < ActiveRecord::Migration
def change
add_column :assignments, :is_self_teammate_review_enabled, :boolean, :default => false
end
end </pre>

===Relevant Tables===
[[File:ER2.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

*We will be adding unit / integration tests to all the files we modify.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-06T23:11:35Z

Srachak: /* Proposed Code Changes */

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-06T21:52:03Z

Srachak: /* Problem Definition: */

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-06T21:28:21Z

Srachak: /* Introduction: */

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-12-06T21:25:46Z

Srachak:

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-11-12T04:02:48Z

Srachak: /* Test Plan: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. It consists of the functionality to add questionnaires to be answered by the students. One such type of questionnaire is the reviews. Here, the students review other students and their work and sometimes their own work. When students review their own teammates for their contribution to an assignment it is termed as a teammate review. The questionnaire has many questions and each question can be of a certain type. For example, one type is rating students out of 5 while another one could be just choosing true/false with a comment. However, as of now there exists no question type which lets the user allocate a certain quantity to each team member and the total quantity should not be greater than a given threshold. This kind of question type say "cake" can be used while comparing the contribution provided by each teammate in a project according to a student and to make sure that the total contribution provided is not greater than 100%.

==Problem Definition:==

Expertiza rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. One “problem” with all of these types is that there is nothing to stop a reviewer from assigning the maximum score to all reviewees. This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Proposed Code Changes==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:ER2.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

====Automated testing using Rspec====

*We will be adding unit / integration tests to all the files we modify.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019

2019-11-12T03:59:51Z

Srachak:

* [[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 - E1980. Sort instructor reports by name, ID, score, etc.]]
* [[CSC/ECE 517 Fall 2019 - E1983. Refactor E1858, Github metrics integration view]]
* [[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 -E1988 Allow reviewer to say review can be shown to class as an example]]
* [[CSC/ECE 517 Fall 2019 - E1975. Generalize Review Versioning]]
* [[CSC/ECE 517 Fall 2019 - E1976. Issues Related to Assignment Creation]]
* [[CSC/ECE 517 Fall 2019 - E1991. Improvements to anonymized view]]
* [[CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design]]

CSC/ECE 517 Fall 2019

2019-11-12T03:58:43Z

Srachak:

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-11-12T03:51:17Z

Srachak: /* Introduction: */

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. It consists of the functionality to add questionnaires to be answered by the students. One such type of questionnaire is the reviews. Here, the students review other students and their work and sometimes their own work. When students review their own teammates for their contribution to an assignment it is termed as a teammate review. The questionnaire has many questions and each question can be of a certain type. For example, one type is rating students out of 5 while another one could be just choosing true/false with a comment. However, as of now there exists no question type which lets the user allocate a certain quantity to each team member and the total quantity should not be greater than a given threshold. This kind of question type say "cake" can be used while comparing the contribution provided by each teammate in a project according to a student and to make sure that the total contribution provided is not greater than 100%.

==Problem Definition:==

Expertiza rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. One “problem” with all of these types is that there is nothing to stop a reviewer from assigning the maximum score to all reviewees. This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Proposed Code Changes==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:ER2.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

Automated testing using Rspec:
*We will be adding unit / integration tests to all the files we modify.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

File:Oodd copy.jpg

2019-11-12T03:32:40Z

Srachak: uploaded a new version of "File:Oodd copy.jpg"

File:Oodd copy.jpg

2019-11-12T03:28:24Z

Srachak: uploaded a new version of "File:Oodd copy.jpg"

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-11-12T03:24:13Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

Expertiza rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. One “problem” with all of these types is that there is nothing to stop a reviewer from assigning the maximum score to all reviewees. This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Oodd_copy.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Proposed Code Changes==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:ER2.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

Automated testing using Rspec:
*We will be adding unit / integration tests to all the files we modify.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

File:Oodd copy.jpg

2019-11-12T03:23:19Z

Srachak:

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-11-12T03:22:01Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

Expertiza rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. One “problem” with all of these types is that there is nothing to stop a reviewer from assigning the maximum score to all reviewees. This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

[[File:Example.jpg]]

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Proposed Code Changes==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:ER2.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

Automated testing using Rspec:
*We will be adding unit / integration tests to all the files we modify.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1992. Add cake type to rubrics design

2019-11-12T03:20:39Z

Srachak:

==Introduction:==

Expertiza is an open source application running on Ruby on Rails. It is used for management of courses and the assignments for respective courses, by the faculties and the students. The manage content section of the application has different views which displays information about the users, courses, assignments, questionnaires, and reviews. The application should have a fully functional search functionality throughout the views, so that a user can search any type of data with ease, on the basis of any number of parameters depending on his requirements. Users should be searched on the basis of one more parameters which include name, full name, email, etc. Similarly, assignments should be searched on the basis of name, created date, updated date, etc. However, the search functionality in the existing application is constrained to just a single parameter for users and assignments. Questionnaires management does not have a search functionality implemented as yet. This project works on improving the search functionality of Expertiza, by adding search bars if not present, introducing advanced search feature where user can search on the basis of more than one parameters and making the search functionality appear more elegant.

==Problem Definition:==

Expertiza rubrics incorporate several kinds of items, including Criterion (dropdown + comment), Checkbox, MultipleChoice, and Scale. One “problem” with all of these types is that there is nothing to stop a reviewer from assigning the maximum score to all reviewees. This is indeed a problem for teammate assessment, when the faculty asks for what fraction of the work each teammate did.So an alternative is needed, let’s call it a “Cake” item type, that allows a reviewer to divide a “cake” in any way between the reviewees, but does not allow him/her to divvy up more than 100% of the cake.

#When the reviewer submits a score that would bring the total assigned for this item to > 100%, the system needs to warn.
#Allow a reviewer to give him/herself a score
# Proposed design needs to be compatible with existing self reviews code and teammates reviews
# Should be extensible to other kind of reviews apart from teammate reviews as well

==Proposed Solution:==
Proposed Solution:

The issue asks us to have a Cake type for the question taking in a participant’s contribution, whenever s/he is reviewing the other teammates. We add in a new Question type ‘Cake’, which will be extended from the Scored Question model [cake < scored question < choice question < question]. We intend to keep the Cake type input in the form of the number of stars, on the lines of the existing code.

Addressing self-reviews for Cake Type:

The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. The point whether the distribution of the cake should include the reviewer himself, is addressed on the basis of the enabling of ‘Self-Review’. If enabled, we include the self contribution to sum it up to one unit (for instance, five stars.) If not, we exclude the reviewer.

There are two ways to integrate the Cake type to the existing flow:

*'''Solution A''': Self-review at team level as an instance of TeammateReviewResponseMap

In the current system workflow, we found that the teammate reviews are taken as instances of TeammateReviewResponseMap. The questionnaire for reviewing teammates includes the question asking the cake (contribution) factor. Ideally, the cake should include the reviewer himself as well.

Currently, whenever a participant is reviewing his teammates, s/he is displayed a page with his current teammates, and this page excludes the logged in user. We include the logged in user ID as well by removing this check, and let him submit his self-review with the same questionnaire as his other teammates have.

The Teammate Review page would be displayed as:

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your team
#You will see a list of your teammates, including self: Choose a member and click on ‘View’
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

*'''Solution B''': Self-review at team level as an instance of SelfReviewResponseMap

Currently, we have self reviews in place at an assignment level. This means that a team can review their own work, similar to how they review their peers. We want to extend the self review functionality to not only review the project but to also review the student as a team member.
We can make use of the existing self review code and extend it to teammate reviews as well.

In the current implementation, a student can perform a self review by going to a particular assignment and clicking on the “Your work” link. If self reviews are enabled for that assignment, then a button will show at the bottom of the page which says “Self review”. Clicking on the button will show a link “Begin”

We want to add another link here, that says “self teammate review”. Such that clicking on the link will render the same questionnaire that is shown for the student to review other teammates.

Steps to reproduce the proposed workflow:
#Log in to expertiza to view the home page
#Login as an Instructor, and then impersonate a student or login as a Student
#Go to Assignments -> Your work
#Click on self review button at the bottom of the page
#You will see a new “self teammate review” link here
#Clicking on the button will render the questionnaire
#You can see the question for asking the contribution as a cake type
#There will be a text description next to it denoting what part of the cake is taken (what contribution factor of the work is used)

Final approach: We decide to go with the proposed Solution A (Self-review at team level as an instance of TeammateReviewResponseMap), since it ensures consistency in the flow, while taking teammate reviews and self-reviews.

==Use Case Diagram==
[[File:UseCaseExpertizaCake.png|center]]

==Proposed Code Changes==

#Edit '''questionnaire/_questionnaire.html.erb''': Add Cake to the list question types
#Create '''cake.rb''' model that inherits from ScoredQuestion model. Add method to calculate currently added weights of the cake to this model.
#Edit '''questionnaires_controller.rb''', under “add_new_questions” method, adding a cake type and handle the changes.
#Edit '''assignments/edit/_review_strategy.html.erb''' and add ‘Allow teammate self-review’ to the list of options.
#Edit '''student_teams/view.html.erb''' and add reviewer to list of displayed teammates and mark that item as self review in the view.
#Edit '''response/response.html.erb''' and add cake type questions to the displayed response.
#Edit '''response/view.html.erb''' and add cake type questions to the displayed response.

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets.

[[File:ER diagram.png|center]]

===Relevant Tables===
[[File:ER2.png|center]]

==Test Plan: ==
====Test Details:====
====UI Testing====

*Reviewing teammates (happy case when contribution is < 100%)
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#Click on review link for a fellow team member
#Fill the responses for the given questions (which include cake type questions as well)
#Save the review

*Giving > 100% for cake questions
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates under team members
#While reviewing a teammate, a student gives 60% as contribution to teammate1
#When he tries to give > 40% for the teammate2. He should see a warning that states that total of the cake is exceeding 100%

*Context: Self reviews can be enabled/ disabled for an assignment as per the choice of the instructor.
#Self reviews enabled
#A student logs on to expertiza and clicks on an assignment
#Then he clicks on your team link
#He should be able to see his teammates and himself (for self review) under team members
#Total contribution for a cake type question in a teammate review should include the contribution provided by the student in the self review as well.
#If the contribution is exceeded, a warning should appear

*Self review disabled
#The link for a reviewer to review himself as a team member should not show
#The cake type questions in the teammate review should include only contributions provided by the other team members

*Context: If self review is enabled after the assignment has been created and a few students have already given reviews, then it should give a warning.
#Self review enabled in the middle of the assignment
#Add teammate review for teammate1
#Add teammate review for teammate2 (make sure it adds upto 100%)
#Enable self review as an instructor
#As a student, notice that a new review button is visible in the “your team” page.
#Click on review, try to add contribution for self and make sure a warning appears that says that the cake is already at 100%

*Context: If self review is disabled after the assignment has been created and a few students have already given reviews.
#Self review disabled in the middle of the assignment
#Enable self review as an instructor
#Add teammate review for teammate1
#Add teammate review for teammate2
#Add self review (make sure it adds upto 100%)
#Disable self review as an instructor
#As a student, notice that the review button is NOT visible in the “your team” page

'''Open question''': what should the expected behavior be? Should we decrease the self review contribution? But this would reduce the total contribution < the desired 100%

Automated testing using Rspec:
*We will be adding unit / integration tests to all the files we modify.

==Team ==

'''Mentor''': Carmen Bentley (cnaiken@ncsu.edu)
*Mita Gavade (magavade@ncsu.edu)
*Srujana Rachakonda (srachak@ncsu.edu)
*Ram Chavali (rlchaval@ncsu.edu)
*Abhirav Kariya (akariya@ncsu.edu)