Expertiza_Wiki - User contributions [en]

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

2019-12-07T07:36:19Z

Akariya: /* Database Design */

==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.

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:Database.png

2019-12-07T07:35:31Z

Akariya: uploaded a new version of "File:Database.png"

Database Schema

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

2019-11-12T02:08:24Z

Akariya: Created page with "==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 facul..."

==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:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==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:TRP.png|1000px|thumb|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)

*'''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-12T02:03:34Z

Akariya:

==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:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==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:TRP.png|1000px|thumb|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)

*'''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-12T02:03:13Z

Akariya:

==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:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==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:TRP.png|1000px|thumb|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)

*'''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-12T01:58:44Z

Akariya: /* 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. 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:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==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:TRP.png|1000px|thumb|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)

*'''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.

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

2019-11-12T01:51:41Z

Akariya:

==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:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==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:TRP_.png|1000 px|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)

*'''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.

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

2019-11-12T01:40:48Z

Akariya:

File:TRP .png

2019-11-12T01:34:35Z

Akariya: new

new

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

2019-11-12T01:31:01Z

Akariya:

==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:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==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:TRP.png | 800 px]]

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==

#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 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: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

File:UseCaseExpertizaCake.png

2019-11-12T01:30:43Z

Akariya:

File:TRP.png

2019-11-12T01:17:30Z

Akariya:

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

2019-11-12T01:12:35Z

Akariya:

==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:==

#An instructor or administrator can search for a user by name, user-ID, or other characteristics.
#An instructor should be able to search for assignments by name, due date, or other characteristics.
#An instructor should be able to search for rubrics (or other questionnaires) by name, or by the courses or assignments they have been used in.
##For the instructor, there also needs to be a way to quickly find rubrics (and other questionnaires) that have been used in a single course. It should be possible to search or click somewhere to bring up a list of questionnaires used in the course, expanding only the applicable questionnaires in the list of questionnaires.
##One should also be able to search for questionnaires by words used in questions that belong to the questionnaires.
#There should be a way to search all reviews of a particular team’s work for particular scores or text strings. Reviews should be able to be filtered by score, text comment length, reviewer and reviewee.
#An instructor or administrator should be able to search for all the assignments that a particular user has participated in.
#If more than one criteria needs to be specified, there should be an 'Advanced Search' button.

==Proposed Solution:==
===Search for User:===

In the current system workflow, we found that the user is unable to search in the Manage Users view. In the proposed workflow, we plan to enable the user to search by all the columns in the UI viz. Name, Full name, Email Address, Role, Parent by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Users
:#Type the search string in the search box available on the UI and select the column to search for from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the specified criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Assignments:===

In the current system implementation, searching via the name of the assignment is supported with partial or complete assignment name. However, the search is case sensitive. In the proposed system, the user will be able to search for an assignment using additional filters such as Creation Date and Updated Date along with Assignment Name. The user will also be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Assignments
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Questionnaires:===

The existing system does not have a search functionality under Questionnaires. The proposed system will implement a search functionality for searching via the name of the questionnaire, the text in the questions within a questionnaire, date of creation, and date updated by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

To search for an assignment by Creation Date, the user will be prompted with a calendar where he can select a date and all the assignments created on or before the selected date will be displayed.

To apply multiple filters, user can tap on the Advanced Search button available, adjacent to the Search button; a hidden div will then be rendered below containing textboxes for all the columns. All assignments that were created before the selected date for Creation Date or Updated Date columns and the ones that match other filters will be returned. A empty list will be returned if the search criteria doesn't match any records in the database. The questionnaires will be grouped on the basis of their courses and will be expanded when clicked.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#Go to Manage > Questionnaires
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

===Search for Reviews:===

The existing system does not have a search functionality under Reviews. The proposed system will implement a search functionality for searching using the attributes like team name, score, reviewer, comment etc. by entering a partial or a complete text that matches with the particular field. We will also allow searching for fields irrespective of the case of the searched string. The user will be able to apply multiple filters at a time and the output of the query will match all the filters applied. If no results are found, an empty list will be returned.

The user will be able to apply multiple filters at a time and the output of the query will match all filters applied. If no results are found, an empty list will be returned.

Steps to reproduce the proposed workflow:
:#Log in to expertiza to view the home page
:#
:#Type the search criteria in the available search criteria and select the appropriate field from the dropdown.
:#To perform search based on multiple filters, the user can tap on the Advanced Search button adjacent to the Search button, the view renders a hidden div containing textboxes for all the columns, allowing the user to search based on multiple columns.
:#All the entries that match the given criteria will be returned.
:#An empty list is returned if the search criteria doesn't match any valid records in the database.

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

==Proposed Code Changes==

The search feature could be implemented in a more RESTful manner by adding it to individual models rather than implementing it as a single controller.

If we followed this approach the search query would be as follows:
#localhost:port/user/search?name=<>
#localhost:port/assignment/search?name=<>
#localhost:port/questionnaire/search?name=<>

Following is the list of search attributes for a given entity along with a list of files that would altered in the process.

User
*Search fields
#username
#user_id
#fullname
#email

*Files to be modified:
#app/views/users/list.html.erb
#app/controllers/users_controller.rb
#app/models/user.rb

Assignment
*Search fields
#assignment_name
#assignee_username
#assignee_name
#due_date_before
#due_date_after
#created_before
#created_after

*Modified files
#app/models/assignment_node.rb

Questionnaire
*Search fields
#name
#text
#course
#assignment
*Modified files
#app/models/questionnaire_node.rb

Review
*Search fields
#team
#text
#min_score
#max_score
*Modified files
#app/views/review_mapping/_searchbox.html.erb
#app/controllers/review_mapping_controller.rb

==Database Design==
Below is the simplified version of the ER diagram which displays the relationships between the entity sets. Team_users and assignment_questionnaires are many to many relationships which are implemented in table format as show below.

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

===Relevant Tables===
[[File:User table.png|center]]
 
[[File:Screen Shot 2018-11-20 at 11.42.06 PM.png|center]]

==Test Plan: ==
=== Automated Tests ===
Automated tests in RSpec will be added as we implement the search functionality for each modified file. Most of the tests added will be unit tests that cover the use cases for each flow and changes made in the model as per the requirement description. 
 
====Test Details:====
=====User Model ( spec/models/user_spec.rb )=====
# Search by user name
# Search by user name that does not exist
# Search by user email
# Search by user email that does not exist
# Search by user email containing a substring
# Search by user full name
# Search by user full name is empty
# Search by user name and email
# Search for assignments participated
 
=====Assignment Model ( spec/models/assignment_spec.rb )=====
# Search by user name
# Search by institution
# Search by creation date
# Search by updated date
 
=====Rubrics=====
# Search by name
# Search by courses used in
# Search by assignments used in
 
=====Reviews=====
# Search all reviews of a particular team’s work for particular scores or text strings.
# Search by score
# Search by text comment length
# Search by reviewer and reviewee
 

=== Manual Tests ===
=====Search for User=====
# Setup: create a user with name="student" and userId="5000" 
# Action: Instructor clicks on manage - > users -> in textbox enters name="student" 
# Response: Relevant details of student, name="student" is displayed 
 
# Action: Instructor clicks on manage - > users -> advanced search->clicks on checkbox student id and enters "5000" and click "ok" 
# Response: Relevant details of student, name="student" is displayed 
 
=====Search for Assignments=====
# Setup create an assignment with name="assignment" and set a due date 
# Action : Instructor clicks on Manage -> Assignments, in textbox enter "assignment" in relevant tab 
# Response : Relevant assignment should be displayed 
 
# Action : Instructor clicks on Manage -> Assignments-> drop down and apply filters for due date and enter date and click "ok" 
# Response : Relevant assignments should be displayed 
 
=====Search for Questionnaires=====
# Setup : Create a Questionnaire, add questions to it 
# Action : Log in as instructor, Manage -> Questionnaires, in text box enter text 
# Response : Questionnaires matching text are shown 
 
# Action : Log in as instructor, Manage -> Questionnaires, click advanced search and check creation date and enter value 
# Response : Questionnaires matching text are shown 
 
=====Search for Reviews=====
# Setup : Setup review for an assignment, login as student and then add review 
# Action : Log in as instructor, Manage -> Assignments, Click on Review Report icon on corresponding assignment 
# Result : Review should be seen 
 
# Action : Click Advanced search, check review by text and enter text 
# Result : Matching review should be visible

File:ERD1.png

2019-11-12T01:08:10Z

Akariya:

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

2019-11-12T01:07:08Z

Akariya:

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

[[File:ER1.jpg]]

Relevant Tables

[[File:ER2.png]]

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 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.

File:ER2.png

2019-11-12T01:06:00Z

Akariya:

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T21:45:43Z

Akariya:

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

'''Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Bugs that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created

== Design and Implementation ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for creating a new bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
# validates if the url provided is of a valid format
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

# Calculates the rating of a bookmark when review type is a rubric and not a dropdown
def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

# fetches the previously added responses to rate a bookmark
def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<td><a href=<%= "http://#{bookmark.url}"%> target='_blank'><%=bookmark.title %></td>

<td><%=truncate(bookmark.description, length: 100) %></td>

<% @bookmark_ratings = BookmarkRating.where(bookmark_id: bookmark.id) %>

<% @bookmark_ratings.to_a.reject! {|bookmark_rating| bookmark_rating.user_id == Bookmark.find(bookmark_rating.bookmark_id).user_id} %>
<% sum = 0 %>
<% @bookmark_ratings.each do |bookmark_rating| %>
<% sum += bookmark_rating.rating %>
<% end %>
<td>
<% if has_dropdown?(@topic) %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
<% else %>

<% avg = BookmarkRating.average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
<% end %>
</td>
<td>

<% if bookmark.user.id != current_user.id %>
<% if has_dropdown?(@topic) %>
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
<%= form_tag :action => "save_bookmark_rating_score", :id => bookmark.id do %>
<% params[:rating] = rating %>
<select id=<%= bookmark.id %> name="rating" style="font-size: 10px">
<% (0..5).each do |i| %>
<option value=<%= i.to_s %>
<% if params[:rating] == i.to_s %>
selected
<% end %>
>
<%= i.to_s %>
</option>
<% end %>
</select>
<% if BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.blank? %>
<%= button_tag "Rate", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% else %>
<%= button_tag "Update", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% end %>
<% end %>
<% else %>

<% bookmark_rating_response_map = BookmarkRating.get_bookmark_rating_response_map(bookmark, current_user) %>
<% if bookmark_rating_response_map.nil? || bookmark_rating_response_map.response.size == 0 %>
<%= link_to "Begin", :action => "new_bookmark_review", :id => bookmark.id %>
<% else %>
<%= link_to "View", view_response_index_path(id: bookmark_rating_response_map.response.first.response_id) %>
<%= link_to "Edit", edit_response_path(id: bookmark_rating_response_map.response.first.response_id, return: 'bookmark') %>
<% end %>
<% end %>
<% end %>
</td>
<% if bookmark.user_id == session[:user].id %>
<td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td>
<td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td>
<% end %>
....
:app/controllers/bookmarks_controller.rb
# method to check if a dropdown is used for rating bookmarks
def has_dropdown?(topic)
bookmark_rating_questionnaire = topic.assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire')
if bookmark_rating_questionnaire[0].nil?
true
else
false
end
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
# Saves the responses to the bookmark review questionnaire.
# If a previous response exists it updates it.
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Future Scope ==
* Giving credit to the author of the bookmark for his contribution

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)

CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements

2019-11-06T21:42:32Z

Akariya:

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and the code is available on Github. It allows students to review each other’s work and improve their work upon this feedback. Students and Instructors (including TA's) use this application though their credentials. Instructors can add new projects, assignments etc as well edit the previous ones and at a later stage can see the student submission and grade them. They can even put a time limit (deadline) for submitting the assignment. Students can form teams for the projects, submit their work through handles (Wiki page, link to a video etc). Students can even review their teammates and other peers, as well give them any suggestions if required

'''Review Assessment Credentials
'''
The credentials for Peer review assessment for Bookmark Enhancement project are
Instructor Login: username => instructor6 password=>password

Accounts for Impersonation: username => student6340, student6341
Assignment => Exercises, CSC456, Fall2015

===== Bookmark Functionality in Expertiza =====

Expertiza features the bookmarking functionality which allows users to help the author of the project by suggesting insights. Let’s say there are five topics that I’m interested in and would like to contribute to, but I can only choose one. Well, for the other topics, I’m allowed to submit hyperlinks to pages that I think would help the author do the work. On each line of the signup sheet are two icons, one for adding a bookmark to the topic, and another for viewing bookmarks on the topic. The bookmarks are attached to each project topic and user can suggest by filling up a questionnaire. As soon as a user creates a bookmark, the project author is able to view all the bookmarks that are created for his project. The author can give a feedback on the bookmark that he has received which helps even the user know the usefuless of his bookmark.

==Bookmark Enhancements==

The Bookmark functionality in expertiza is in its nascent stage which allows user to provide feedback on the projects that he is interested in. It also allows the author to rate the bookmarks that he has received for his project. Project Juniper Bookmark Enhancements is an attempt to make the bookmarks more user-friendly and credible. We have improved the functionality for an author to descriptively evaluate the bookmark that he has received on his project using rubrics as set by the instructor.

=== Bugs that were identified ===

*Fixing the “Back” button
*Validations on the form for adding bookmarks were missing
*Allowed the creator of bookmark to rate himself and fixed the logic for calculating average rating
*Bookmark Rating Questionnaire could not be created
*Functionality for review of bookmarks using rubric

== Design and Implementation ==

'''Fixing the Back button:'''
When user visits “Create Bookmarks" and "View Bookmarks", the back button was not functional which refrained the user from going back to the Signup-sheet. Now this issue has been fixed which in future will allow to any contributor to use this back functionality.

Earlier: [[File: Backbutton_old.png ]]

Files Changed:
:app/controllers/bookmarks_controller.rb
def list
@participant = Participant.where(user_id: session[:user].id).first
@bookmarks = Bookmark.where(topic_id: params[:id])
@topic = SignUpTopic.find(params[:id])
end

def new
@participant = Participant.where(user_id: session[:user].id).first
@topic = SignUpTopic.find(params[:id])
@bookmark = Bookmark.new
end

:app/views/bookmarks/list.html.erb 
<%= link_to 'Back', :controller=> 'sign_up_sheet', :action=>'list', :id => @participant.id, :assignment_id => @topic.assignment_id %>

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/aad5803b1e2bb49c17cff082d9d0661eb5e5f4aa?file-filters%5B%5D=.erb&file-filters%5B%5D=.rb&file-filters%5B%5D=No+extension#diff-dfb6f1f1b681adb17aeaef26d931880b here]

The screencast can be found [https://drive.google.com/file/d/1CqxFbLjmh3nQ-gi4PFZVJzIok_-xrpJU/view?usp=sharing here:]

'''Bookmark Validations '''
The form for creating a new bookmark allowed malformed URLs to be entered into the system. Now, the bookmarks can be added only when user enters legitimate URL as well as all the fields are completely filled. Validations were added as a security measure to prevent misuse.

Files Changed:
:app/controllers/bookmarks_controller.rb

def update
....
begin
@bookmark.update_attributes!(url: params[:bookmark][:url], title: params[:bookmark][:title], description: params[:bookmark][:description])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, 'Your bookmark has been successfully updated!', request)
flash[:success] = 'Your bookmark has been successfully updated!'
rescue StandardError
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, $ERROR_INFO.to_s, request)
flash[:error] = 'Bookmark could not be updated: ' + $ERROR_INFO.to_s
end
....
end

:app/models/bookmark.rb
class Bookmark < ActiveRecord::Base
....
# validates if the url provided is of a valid format
validates_format_of :url, :multiline => true, :with => /^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/)?[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/, :on => :create
....
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/4f70a3dc25dddf04c671186d52f0942b744d91da here:]

The screencast can be found [https://drive.google.com/file/d/14A9e76pcd6HoNEYFzPrfH4xR3HBjps-c/view?usp=sharing here:]

'''Self Rating of Bookmarks and average calculation'''
When reviewing the bookmark, the average rating for that bookmark shown was calculated wrongly and showed average rating for the bookmark that wasn’t reviewed. Also, the user who created the bookmark could rate himself.
Now, the user cannot rate his own bookmarks and the average rating is calculated perfectly after one or more people have reviewed it.

Files Changed:
:app/models/bookmark_rating.rb

# Calculates the rating of a bookmark when review type is a rubric and not a dropdown
def average_based_on_rubric(bookmark)
if bookmark.nil?
0
else
assignment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assignment.id,
reviewee_id: bookmark.id
).flat_map {|r| Response.where(map_id: r.id) }
scores = Answer.compute_scores(responses, questions)
if scores[:avg].nil?
0
else
(scores[:avg] * 5.0 / 100.0).round(2)
end
end
end

# fetches the previously added responses to rate a bookmark
def self.get_bookmark_rating_response_map(bookmark, current_user)
BookmarkRatingResponseMap.find_by(
reviewed_object_id: SignUpTopic.find(bookmark.topic_id).assignment.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id,
reviewee_id: bookmark.id
)

:app/views/bookmarks/list.html.erb
....
<td><a href=<%= "http://#{bookmark.url}"%> target='_blank'><%=bookmark.title %></td>

<td><%=truncate(bookmark.description, length: 100) %></td>

<% @bookmark_ratings = BookmarkRating.where(bookmark_id: bookmark.id) %>

<% @bookmark_ratings.to_a.reject! {|bookmark_rating| bookmark_rating.user_id == Bookmark.find(bookmark_rating.bookmark_id).user_id} %>
<% sum = 0 %>
<% @bookmark_ratings.each do |bookmark_rating| %>
<% sum += bookmark_rating.rating %>
<% end %>
<td>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if @bookmark_ratings.size > 0 %>
<%= (sum * 1.0 / @bookmark_ratings.size).round(1) %>
<% else %>
<%= '-' %>
<% end %>
<% else %>

<% avg = BookmarkRating.average_based_on_rubric(bookmark) %>
<%= avg == 0 ? '-' : avg %>
<% end %>
</td>
<td>

<% if bookmark.user.id != current_user.id %>
<% if BookmarkRatingQuestionnaire.has_dropdown?(@topic) %>
<% if BookmarkRating.exists?(bookmark_id: bookmark.id, user_id: session[:user].id) %>
<% rating = BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.rating.to_s %>
<% else %>
<% rating = "0" %>
<% end %>
<%= form_tag :action => "save_bookmark_rating_score", :id => bookmark.id do %>
<% params[:rating] = rating %>
<select id=<%= bookmark.id %> name="rating" style="font-size: 10px">
<% (0..5).each do |i| %>
<option value=<%= i.to_s %>
<% if params[:rating] == i.to_s %>
selected
<% end %>
>
<%= i.to_s %>
</option>
<% end %>
</select>
<% if BookmarkRating.where(bookmark_id: bookmark.id, user_id: session[:user].id).first.blank? %>
<%= button_tag "Rate", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% else %>
<%= button_tag "Update", {:id=>'button'+bookmark.id.to_s,:style=>"font-size:10px; display:none;"} %>
<% end %>
<% end %>
<% else %>

<% bookmark_rating_response_map = BookmarkRating.get_bookmark_rating_response_map(bookmark, current_user) %>
<% if bookmark_rating_response_map.nil? || bookmark_rating_response_map.response.size == 0 %>
<%= link_to "Begin", :action => "new_bookmark_review", :id => bookmark.id %>
<% else %>
<%= link_to "View", view_response_index_path(id: bookmark_rating_response_map.response.first.response_id) %>
<%= link_to "Edit", edit_response_path(id: bookmark_rating_response_map.response.first.response_id, return: 'bookmark') %>
<% end %>
<% end %>
<% end %>
</td>
<% if bookmark.user_id == session[:user].id %>
<td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td>
<td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td>
<% end %>
....
:app/controllers/bookmarks_controller.rb
# method to check if a dropdown is used for rating bookmarks
def has_dropdown?(topic)
bookmark_rating_questionnaire = topic.assignment.questionnaires.where(type: 'BookmarkRatingQuestionnaire')
if bookmark_rating_questionnaire[0].nil?
true
else
false
end
end

The changed code can be found [https://github.com/expertiza/expertiza/pull/1540/commits/3ad53b0cbd9b06f4a3a3ff85311c38f5b5672970?file-filters%5B%5D= here:]

'''Review bookmark using rubric functionality'''
The bookmark functionality earlier only allowed for the users to rate the bookmark and not give feedback about the the quality of the Bookmark. Now, feature is added so that the instructor can decide whether to allow for bookmark to be just rated or a have a rubric . The instructor can customize the questions in the rubric. The rubric once created by the instructor can be used for multiple assignments and also multiple rubrics can be created for different types of assignments.

Files Modified
:app/controllers/bookmarks_controller.rb

.....
# Saves the responses to the bookmark review questionnaire.
# If a previous response exists it updates it.
def new_bookmark_review
bookmark = Bookmark.find(params[:id])
topic = SignUpTopic.find(bookmark.topic_id)
assignment_participant = AssignmentParticipant.find_by(user_id: current_user.id)
response_map = BookmarkRatingResponseMap.where(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
).first
if response_map.nil?
response_map = BookmarkRatingResponseMap.create(
reviewed_object_id: topic.assignment.id,
reviewer_id: assignment_participant.id,
reviewee_id: bookmark.id
)
end
redirect_to new_response_url(id: response_map.id, return: 'bookmark')
end
.....

:app/controllers/questionnaires_controller.rb

if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)
display_type = (display_type.split /(?=[A-Z])/).join("%")
end
@questionnaire.display_type = display_type

:app/controllers/response_controller.rb

when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id

def set_questionnaire_for_new_response
.
.
"GlobalSurveyResponseMap",
"BookmarkRatingResponseMap"
@questionnaire = @map.questionnaire
end
end

The screencast can be found [https://drive.google.com/file/d/1W5xQCox-p_njQt_t8-yVkhn3B0HalKGk/view?usp=sharing here:]

== Testing Plan ==

===Testing From UI ===

* Enable Bookmarks
# After logging in as instructor, go to Manage > Assignments
# Select Edit under Actions for assignment
# Under Topics Tab select 'Allow participants to create bookmarks?' to allow bookmarks
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire to use the rubric for reviewing the bookmarks , select None for dropdown.

'''Note''': When 'Bookmark Rating' is 'None', the error the error 'You did not specify all the necessary rubrics. You need [BookmarkRating] of assignment Exercises before saving the assignment. You can assign rubrics here.' is out of scope of the current project and the error can safely be ignored from point of view of this project
'
* Fixing the back Button & Validations
# Log in as an instructor and impersonate as a student using the credentials given above
# Select ‘Exercises’ assignment and go to the Signup sheet
# We can see a list of projects with 2 columns to add or remove the Bookmark, select any of them
# You’ll be redirected to the corresponding page where the back button will be visible
# Select add bookmark and the form can be tested for Validations.

*Create new Bookmark Rating Rubric
# As an instructor, go to Manage>Questionnaires and select Bookmark Rating field
#Create a new rubric with required details
# Start adding questions. This can be done by manually entering into the system or importing Questionnaire.

*View Bookmarks

# Log in as an instructor and impersonate as user using the credentials mentioned above and then select assignment "Exercises"
# Add bookmarks to other topics.
# The owner of that project should be able to see all the bookmarks created for his project and can rate the bookmark through the way instructor has defined it (rating or rubric).

=== Automated Testing with RSpec ===
The current version of expertiza did not have any test for the BookmarksController and the Bookmarks model. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for BookmarksController, to test all the modifications we have done to the code of the controller class. We have also added unit tests to the bookmarks model. The tests can be executed using the "bundle exec rspec filename" command as shown below.

user-expertiza $bundle exec rspec spec_file_path
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's 'rails' settings.
Randomized with seed 5067
......................
Finished in 1 minute 50.34 seconds (files took 10.6 seconds to load)
22 examples, 0 failures
Randomized with seed 5067

==Deployment==
This application with the mentioned changes have been deployed on VCL and can be found at [http://152.46.19.205:8080 http://152.46.19.205:8080]

== Future Scope ==
*
*

== References ==
#Github Link: https://github.com/srujana13/expertiza
#Pull Request: https://github.com/expertiza/expertiza/pull/1540/
#http://wiki.expertiza.ncsu.edu/index.php/E1830_OSS_Project_Juniper:_Bookmark_enhancements
# Expertiza on Github https://github.com/expertiza/expertiza

==Contributors==
#Tanvi Pandit (tmpandi2@ncsu.edu)
#Abhirav Kariya (akariya@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)
#Mentor Edward Gehringer (efg@ncsu.edu)