Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-12-19T02:41:38Z

Hcao5: /* Introduction */

== Introduction ==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1981) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

The github repository is https://github.com/Jas0nch/expertiza. And the demo video in youtube is https://youtu.be/8pLKBOgDggM

== Proposed solution ==
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

== Implementation ==

=== Design Strategy ===

Goal: In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). We'll add a new subclass of Questionnaire called, say, SupplementalReviewQuestionnaire.

1. there should be a checkbox when creating the whole questionnaire to indicate whether this questionnaire will have supplemental review questions or not.

2. there should be a button that has the content "add supplemental questions".

a. if you click that button, it will redirect to a page that an instructor uses to create a supplemental questionnaire.

b. when the supplemental questionnaire is created, it should append to the existed questionnaire.

3. After the reviewer finished the review, student can find the supplemental questionnaire in the review page.

How we will do this:

1. add a variable in the questionnaire class.

2. add another file for a supplemental questionnaire and save them to the database.

3. add a method to get the corresponding supplemental questionnaire and to add questions into the existed questionnaire.

4. we should add another method to show the supplemental questionnaire in the review page.

=== Modifications in the User Interface (Todo) ===

1. Assignment Creation Page in Instructor's Account

We plan to implement a check box under the column of Rubrics in the assignment creation page indicating whether the instructor allows students to add specific questionnaires with respect to their projects.

2. Your Work Page in A Student's Account

We plan to implement a link or button on the Your Work page of an assignment of a student whose assignment is enabled to create supplementary review questionnaires by the instructor, in order to redirect to the Review Rubrics Creation page.

3. Review Rubrics Creation Page

In this page, students are able to create supplementary review questions regarding the specifics of their own assignments.

4. Review Page

In the Review Page of reviewers, the supplementary review questions created by the owner of the assignment will be shown to reviewers along with the standard review questions created by the instructor.

5. Review Results Page

The Review Results Page should display the results of standard questions created by the instructor as well as the results of supplementary review questions created by the instructor.

== Use Cases ==

[[File:Use_Cases.jpg‎]]

== Test Plan ==

=== RSpec Test ===

* There should be no link for "Supplementary Review Questionnaire" for team members or reviewerss, if the instructor disables this section in Assignment Creation Page.

* If the instructor enables this section, the link for "Supplementary Review Questionnaire" should appear in the "Your Work" section of a student, and redirect to Review Rubrics Creation Page.

* After created or edited, the supplementary review questions should appear as part of the whole review question sheet in Review Page (along with the standard review questions created by the instructor), to team members, reviewers, and the instructor.

* After a reviewer saves or submits, the responses to the supplementary review questions should appear when (s)he views the responses.

* After review deadline, all responses to the supplementary review questions of reviewers should appear in My score page of students.

<br>

=== Test Results ===

'''spec/controllers/supplementary_review_questionnaires_spec.rb'''

Test if the link of "Create Supplementary Review Questionnaire" correctly redirects to the right page.

<pre>
describe SupplementaryReviewQuestionnairesController do
let(:team) { build(:assignment_team, id: 1, name: "team1", assignment: assignment) }
let(:student1) { build(:student, id: 1, name: "student1") }
let(:student2) { build(:student, id: 2, name: "student2") }
let(:participant) { build(:participant, id: 1, user: student1, assignment: assignment) }
let(:participant2) { build(:participant, id: 2, user: student2, assignment: assignment) }
let(:assignment) { build(:assignment, id: 1) }

# test the method of create_supplementary_review_questionnaire
describe '#create_supplementary_review_questionnaire' do
it 'redirects to questionnaires#edit page after create a new supplementary review questionnaire' do
session = {user: student1}
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
allow(Team).to receive(:find).with(1).and_return(team)
params = {id: 1}
get :create_supplementary_review_questionnaire, params, session
expect(response).to redirect_to("/supplementary_review_questionnaires/#{team.supplementary_review_questionnaire_id}/edit")
end
end

end
</pre>

'''spec/features/supplementary_review_questionnaire_spec.rb'''

Test if a supplementary questionnaire can be created, modifid and stored.

<pre>
describe "Supplementary Review Questionnaire", js: true do
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: "TestAssignment")
create_list(:participant, 3)
create(:topic, topic_name: "TestTopic")
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
(1..3).each do |i|
create(:course, name: "Course #{i}")
end

(1..3).each do |i|
create(:questionnaire, name: "ReviewQuestionnaire#{i}")
create(:questionnaire, name: "AuthorFeedbackQuestionnaire#{i}", type: 'AuthorFeedbackQuestionnaire')
create(:questionnaire, name: "TeammateReviewQuestionnaire#{i}", type: 'TeammateReviewQuestionnaire')
end
end

def signup_topic
user = User.find_by(name: "student2064")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
visit '/sign_up_sheet/sign_up?id=1&topic_id=1' # signup topic
visit '/student_task/list'
click_link "TestAssignment"
expect(page).to have_content("Your work")
click_link "Your work"
end

it "can create assignment with supplementary review questoinnaire" do
# Instructor logs in and visits the page of assignment creation
login_as("instructor6")
visit '/assignments/new?private=1'

# Fill in the form under 'General'
fill_in 'assignment_form_assignment_name', with: 'test assignment'
select('Course 2', from: 'assignment_form_assignment_course_id')
fill_in 'assignment_form_assignment_directory_path', with: 'test directory'
check("team_assignment")

# Fill in the form under 'Rubrics'
click_link 'Rubrics'

within(:css, "tr#questionnaire_table_ReviewQuestionnaire") do
select "ReviewQuestionnaire2", from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
end

within(:css, "tr#questionnaire_table_AuthorFeedbackQuestionnaire") do
select "AuthorFeedbackQuestionnaire2", from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
end

within(:css, "tr#questionnaire_table_TeammateReviewQuestionnaire") do
select "TeammateReviewQuestionnaire2", from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
end

# Fill in the form under Review strategy
click_link 'Review strategy'
check 'assignment_form_assignment_is_supplementary_review_enabled'

# Click to create the assignment
click_button 'Create'

# check if the assignment is created successfully
assignment = Assignment.where(name: 'test assignment').first
expect(assignment).to have_attributes(
is_supplementary_review_enabled: true
)
end

it "can add supplementary review questions" do
signup_topic
click_link 'Create/Edit Supplementary Review Questionnaire'
expect(page).to have_content("Edit Review")
end
end
</pre>

'''spec/models/team_spec.rb'''

<pre>
describe '.get_supplementary_review_questionnaire_id_of_team' do
it 'return supplementary_review_questionnaire_id of team' do
allow(Team).to receive(:find).with(1).and_return(team)
expect(Team.get_supplementary_review_questionnaire_id_of_team(1)).to eq(1)
end
end
</pre>

<br>

=== UI Test ===

1. When a new assignment is created, the instructor can enable supplementary questionnaire via the highlighted checkbox.

a. Log in as an instructor, create a new assignment.<br>
b. In the Review Strategy table, check "Allow student-generated questions added to rubric?".<br>
c. Create two teams each containing two students.

[[File:create_new_assignment.png]]

2. In the submit stage, all team members can create and edit one supplementary quetionnaire to their team.

a. Impersonate as a student, there will be a link to "create supplementary review questionnaire" as highlighted, in the "Your work" page.<br>
b. Click on the link, and you will be able to add, edit, and remove questions of the supplementary questionnaire which belongs to your team.<br>
c. Switch to another member of the same team, then you will be able to modify the same supplementary questionnaire.

[[File:create_supplementary_questionnaire.png]]

[[File:create_supplementary_questionnaire_2.png]]

3. In the review stage, reviewers will get one complete questionnaire (including both the regular questionnaire created by intructor, and the supplementary questionnaire created by the team) and do the review.

a. Revert as instructor, change the due date to make it forward to review stage.<br>
b. Impersonate as every student.<br>
c. Request a review, then begin it, edit, save, submit, and view the responses.<br>
d. The questionnaire will completely include both parts, and your responses will correctly show in the view page.

[[File:view_responses_reviewer.png]]

4. After review stage, team members can view the list of all the scores and responses of the complete questionnaire of their team.

a. Impersonate as any student.<br>
b. Click on "Your score" to see all the scores and responses of your complete questionnaire.<br>
c. The table correctly shows the scores and respones from reviewers.<br>
d. Click on "toggle question list" to see your questionaire. It correctly includes both parts.

[[File:view_your_score.png]]

== Files added/modified ==

All modifications are included in the [https://github.com/expertiza/expertiza/pull/1658 Pull Request].

'''A new class SupplementaryReviewQuestionnaire (subclass of Questionnaire) is created.'''

app/controllers/supplementary_review_questionnaires_controller.rb

app/models/supplementary_review_questionnaire.rb

app/models/questionnaire.rb

'''A new boolean column :is_supplementary_review_enabled is added to Assignment.'''

db/migrate/20191126025227_add_is_supplementary_review_enabled_to_assignment.rb

'''Routes related to SupplementaryReviewQuestionnaire are updated.'''

config/routes.rb

'''A new integer column :supplementary_review_questionnaire_id is added to Team.'''

app/models/team.rb

db/migrate/20191126032312_add_supplementary_review_questionnaire_id_to_team.rb

'''Supplementary questions are found and added into controllers and views.'''

app/controllers/grades_controller.rb

app/controllers/questionnaires_controller.rb

app/controllers/response_controller.rb

app/helpers/grades_helper.rb

app/models/response.rb

app/views/response/response.html.erb

'''Modifications on view pages including checkbox and links.'''

app/views/assignments/edit/_review_strategy.html.erb

app/views/submitted_content/_main.html.erb

'''Tests added or modified.'''

spec/controllers/questionnaires_controller_spec.rb

spec/controllers/supplementary_review_questionnaires_controller_spec.rb

spec/controllers/supplementary_review_questionnaires_spec.rb

spec/factories/factories.rb

spec/features/supplementary_review_questionnaire_spec.rb

spec/models/assignment_spec.rb

spec/models/team_spec.rb

== Team members ==
Hua Cao

Heng Yu

Chien-Yuan Wang

Benjamin Ding

== Links ==
Expertiza on Github:

https://github.com/Jas0nch/expertiza/tree/beta

Pull Request:

[https://github.com/expertiza/expertiza/pull/1658 Issue #1658]

Pull Request History:

[https://github.com/Jas0nch/expertiza/pull/6 Add supplementary questions for students]

[https://github.com/Jas0nch/expertiza/pull/8 Supplementary questionnaire and responses can be correctly shown, edited, and stored.]

[https://github.com/Jas0nch/expertiza/pull/9 Add supplementary questions in grades controller]

[https://github.com/Jas0nch/expertiza/pull/10 Add supplementary questions for retrieve_questins method]

[https://github.com/Jas0nch/expertiza/pull/11 Add test for questionnares_controller and .get_supplementary_review_questionnaire_id_of_team.]

[https://github.com/Jas0nch/expertiza/pull/12 Add tests for check box and link in your work and fix bugs]

Video:

https://youtu.be/yeAjjgaV10w

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-12-18T03:26:49Z

Hcao5: /* Introduction */

== Introduction ==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1981) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

The github repository is https://github.com/Jas0nch/expertiza. And the demo video in youtube is https://www.youtube.com/watch?v=yeAjjgaV10w&feature=youtu.be

== Proposed solution ==
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

== Implementation ==

=== Design Strategy ===

Goal: In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). We'll add a new subclass of Questionnaire called, say, SupplementalReviewQuestionnaire.

1. there should be a checkbox when creating the whole questionnaire to indicate whether this questionnaire will have supplemental review questions or not.

2. there should be a button that has the content "add supplemental questions".

a. if you click that button, it will redirect to a page that an instructor uses to create a supplemental questionnaire.

b. when the supplemental questionnaire is created, it should append to the existed questionnaire.

3. After the reviewer finished the review, student can find the supplemental questionnaire in the review page.

How we will do this:

1. add a variable in the questionnaire class.

2. add another file for a supplemental questionnaire and save them to the database.

3. add a method to get the corresponding supplemental questionnaire and to add questions into the existed questionnaire.

4. we should add another method to show the supplemental questionnaire in the review page.

=== Modifications in the User Interface (Todo) ===

1. Assignment Creation Page in Instructor's Account

We plan to implement a check box under the column of Rubrics in the assignment creation page indicating whether the instructor allows students to add specific questionnaires with respect to their projects.

2. Your Work Page in A Student's Account

We plan to implement a link or button on the Your Work page of an assignment of a student whose assignment is enabled to create supplementary review questionnaires by the instructor, in order to redirect to the Review Rubrics Creation page.

3. Review Rubrics Creation Page

In this page, students are able to create supplementary review questions regarding the specifics of their own assignments.

4. Review Page

In the Review Page of reviewers, the supplementary review questions created by the owner of the assignment will be shown to reviewers along with the standard review questions created by the instructor.

5. Review Results Page

The Review Results Page should display the results of standard questions created by the instructor as well as the results of supplementary review questions created by the instructor.

== Use Cases ==

[[File:Use_Cases.jpg‎]]

== Test Plan ==

=== RSpec Test ===

* There should be no link for "Supplementary Review Questionnaire" for team members or reviewerss, if the instructor disables this section in Assignment Creation Page.

* If the instructor enables this section, the link for "Supplementary Review Questionnaire" should appear in the "Your Work" section of a student, and redirect to Review Rubrics Creation Page.

* After created or edited, the supplementary review questions should appear as part of the whole review question sheet in Review Page (along with the standard review questions created by the instructor), to team members, reviewers, and the instructor.

* After a reviewer saves or submits, the responses to the supplementary review questions should appear when (s)he views the responses.

* After review deadline, all responses to the supplementary review questions of reviewers should appear in My score page of students.

<br>

=== Test Results ===

'''spec/controllers/supplementary_review_questionnaires_spec.rb'''

Test if the link of "Create Supplementary Review Questionnaire" correctly redirects to the right page.

<pre>
describe SupplementaryReviewQuestionnairesController do
let(:team) { build(:assignment_team, id: 1, name: "team1", assignment: assignment) }
let(:student1) { build(:student, id: 1, name: "student1") }
let(:student2) { build(:student, id: 2, name: "student2") }
let(:participant) { build(:participant, id: 1, user: student1, assignment: assignment) }
let(:participant2) { build(:participant, id: 2, user: student2, assignment: assignment) }
let(:assignment) { build(:assignment, id: 1) }

# test the method of create_supplementary_review_questionnaire
describe '#create_supplementary_review_questionnaire' do
it 'redirects to questionnaires#edit page after create a new supplementary review questionnaire' do
session = {user: student1}
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
allow(Team).to receive(:find).with(1).and_return(team)
params = {id: 1}
get :create_supplementary_review_questionnaire, params, session
expect(response).to redirect_to("/supplementary_review_questionnaires/#{team.supplementary_review_questionnaire_id}/edit")
end
end

end
</pre>

'''spec/features/supplementary_review_questionnaire_spec.rb'''

Test if a supplementary questionnaire can be created, modifid and stored.

<pre>
describe "Supplementary Review Questionnaire", js: true do
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: "TestAssignment")
create_list(:participant, 3)
create(:topic, topic_name: "TestTopic")
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
(1..3).each do |i|
create(:course, name: "Course #{i}")
end

(1..3).each do |i|
create(:questionnaire, name: "ReviewQuestionnaire#{i}")
create(:questionnaire, name: "AuthorFeedbackQuestionnaire#{i}", type: 'AuthorFeedbackQuestionnaire')
create(:questionnaire, name: "TeammateReviewQuestionnaire#{i}", type: 'TeammateReviewQuestionnaire')
end
end

def signup_topic
user = User.find_by(name: "student2064")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
visit '/sign_up_sheet/sign_up?id=1&topic_id=1' # signup topic
visit '/student_task/list'
click_link "TestAssignment"
expect(page).to have_content("Your work")
click_link "Your work"
end

it "can create assignment with supplementary review questoinnaire" do
# Instructor logs in and visits the page of assignment creation
login_as("instructor6")
visit '/assignments/new?private=1'

# Fill in the form under 'General'
fill_in 'assignment_form_assignment_name', with: 'test assignment'
select('Course 2', from: 'assignment_form_assignment_course_id')
fill_in 'assignment_form_assignment_directory_path', with: 'test directory'
check("team_assignment")

# Fill in the form under 'Rubrics'
click_link 'Rubrics'

within(:css, "tr#questionnaire_table_ReviewQuestionnaire") do
select "ReviewQuestionnaire2", from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
end

within(:css, "tr#questionnaire_table_AuthorFeedbackQuestionnaire") do
select "AuthorFeedbackQuestionnaire2", from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
end

within(:css, "tr#questionnaire_table_TeammateReviewQuestionnaire") do
select "TeammateReviewQuestionnaire2", from: 'assignment_form[assignment_questionnaire][][questionnaire_id]'
end

# Fill in the form under Review strategy
click_link 'Review strategy'
check 'assignment_form_assignment_is_supplementary_review_enabled'

# Click to create the assignment
click_button 'Create'

# check if the assignment is created successfully
assignment = Assignment.where(name: 'test assignment').first
expect(assignment).to have_attributes(
is_supplementary_review_enabled: true
)
end

it "can add supplementary review questions" do
signup_topic
click_link 'Create/Edit Supplementary Review Questionnaire'
expect(page).to have_content("Edit Review")
end
end
</pre>

'''spec/models/team_spec.rb'''

<pre>
describe '.get_supplementary_review_questionnaire_id_of_team' do
it 'return supplementary_review_questionnaire_id of team' do
allow(Team).to receive(:find).with(1).and_return(team)
expect(Team.get_supplementary_review_questionnaire_id_of_team(1)).to eq(1)
end
end
</pre>

<br>

=== UI Test ===

1. When a new assignment is created, the instructor can enable supplementary questionnaire via the highlighted checkbox.

a. Log in as an instructor, create a new assignment.<br>
b. In the Review Strategy table, check "Allow student-generated questions added to rubric?".<br>
c. Create two teams each containing two students.

[[File:create_new_assignment.png]]

2. In the submit stage, all team members can create and edit one supplementary quetionnaire to their team.

a. Impersonate as a student, there will be a link to "create supplementary review questionnaire" as highlighted, in the "Your work" page.<br>
b. Click on the link, and you will be able to add, edit, and remove questions of the supplementary questionnaire which belongs to your team.<br>
c. Switch to another member of the same team, then you will be able to modify the same supplementary questionnaire.

[[File:create_supplementary_questionnaire.png]]

[[File:create_supplementary_questionnaire_2.png]]

3. In the review stage, reviewers will get one complete questionnaire (including both the regular questionnaire created by intructor, and the supplementary questionnaire created by the team) and do the review.

a. Revert as instructor, change the due date to make it forward to review stage.<br>
b. Impersonate as every student.<br>
c. Request a review, then begin it, edit, save, submit, and view the responses.<br>
d. The questionnaire will completely include both parts, and your responses will correctly show in the view page.

[[File:view_responses_reviewer.png]]

4. After review stage, team members can view the list of all the scores and responses of the complete questionnaire of their team.

a. Impersonate as any student.<br>
b. Click on "Your score" to see all the scores and responses of your complete questionnaire.<br>
c. The table correctly shows the scores and respones from reviewers.<br>
d. Click on "toggle question list" to see your questionaire. It correctly includes both parts.

[[File:view_your_score.png]]

== Files added/modified ==

All modifications are included in the [https://github.com/expertiza/expertiza/pull/1658 Pull Request].

'''A new class SupplementaryReviewQuestionnaire (subclass of Questionnaire) is created.'''

app/controllers/supplementary_review_questionnaires_controller.rb

app/models/supplementary_review_questionnaire.rb

app/models/questionnaire.rb

'''A new boolean column :is_supplementary_review_enabled is added to Assignment.'''

db/migrate/20191126025227_add_is_supplementary_review_enabled_to_assignment.rb

'''Routes related to SupplementaryReviewQuestionnaire are updated.'''

config/routes.rb

'''A new integer column :supplementary_review_questionnaire_id is added to Team.'''

app/models/team.rb

db/migrate/20191126032312_add_supplementary_review_questionnaire_id_to_team.rb

'''Supplementary questions are found and added into controllers and views.'''

app/controllers/grades_controller.rb

app/controllers/questionnaires_controller.rb

app/controllers/response_controller.rb

app/helpers/grades_helper.rb

app/models/response.rb

app/views/response/response.html.erb

'''Modifications on view pages including checkbox and links.'''

app/views/assignments/edit/_review_strategy.html.erb

app/views/submitted_content/_main.html.erb

'''Tests added or modified.'''

spec/controllers/questionnaires_controller_spec.rb

spec/controllers/supplementary_review_questionnaires_controller_spec.rb

spec/controllers/supplementary_review_questionnaires_spec.rb

spec/factories/factories.rb

spec/features/supplementary_review_questionnaire_spec.rb

spec/models/assignment_spec.rb

spec/models/team_spec.rb

== Team members ==
Hua Cao

Heng Yu

Chien-Yuan Wang

Benjamin Ding

== Links ==
Expertiza on Github:

https://github.com/Jas0nch/expertiza/tree/beta

Pull Request:

[https://github.com/expertiza/expertiza/pull/1658 Issue #1658]

Pull Request History:

[https://github.com/Jas0nch/expertiza/pull/6 Add supplementary questions for students]

[https://github.com/Jas0nch/expertiza/pull/8 Supplementary questionnaire and responses can be correctly shown, edited, and stored.]

[https://github.com/Jas0nch/expertiza/pull/9 Add supplementary questions in grades controller]

[https://github.com/Jas0nch/expertiza/pull/10 Add supplementary questions for retrieve_questins method]

[https://github.com/Jas0nch/expertiza/pull/11 Add test for questionnares_controller and .get_supplementary_review_questionnaire_id_of_team.]

[https://github.com/Jas0nch/expertiza/pull/12 Add tests for check box and link in your work and fix bugs]

Video:

https://youtu.be/yeAjjgaV10w

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-12-07T03:05:45Z

Hcao5: /* Introduction */

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-12-07T03:04:28Z

Hcao5: /* Introduction */

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-13T17:51:38Z

Hcao5: /* Introduction */

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T03:29:49Z

Hcao5: /* Design Strategy */

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T03:29:28Z

Hcao5: /* Implementation */

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T03:29:14Z

Hcao5: /* Implementation */

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T03:27:57Z

Hcao5: /* Design Strategy */

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T01:46:52Z

Hcao5:

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T01:43:25Z

Hcao5:

== Introduction ==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

=== Proposed solution ===
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

== Implementation ==

''Design Strategy''

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

''Changes in the User Interface''

1. Assignment Page

We add a checkbox for the professor to indicate if student can add their own questions.

2. A button called "Create Supplementary Rubric" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the button he/she can add the desired questions.

3. The page where student will be directed to when he/she clicks the Create Supplementary Rubric button. Students can add Questions to the created Supplementary Review questionnaire here.

4. Review Page

The students own supplementary questions are leading by a heading "Supplementary Review Questions".

5. Review Results Page

The supplementary review results will be showed to the team like other results.

'''Use Cases'''
----

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

'''Test Plan'''
----
Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

'''File which are added/modified'''
----

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

1. Models

app/models/team.rb

Look up the questionnaire ID of a team.

<pre>
def self.get_supplementary_review_questionnaire_id_of_team(team_id)
team = Team.find(team_id)
if team.blank?
nil
else
team.supplementary_review_questionnaire_id
end
end
</pre>

app/models/supplementary_review_questionnaire.rb

Add the SupplementaryReviewQuestionnaire class which is the subclass of Questionnaire.

<pre>

# This is one type of Questionnaire and as intuitively expected this model class
# derives from Questionnaire.
class SupplementaryReviewQuestionnaire < Questionnaire
# Make me better.
attr_accessible
end
</pre>

app/models/response.rb

Add supplementary review responses to "Show Review" section.

<pre>
def construct_review_response code, self_id, show_tags = nil, current_user = nil
code += '<table id="review_' + self_id + '" style="display: none;" class="table table-bordered">'
answers = Answer.where(response_id: self.response_id)
team_id = response_map.reviewee_id
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(team_id)
unless answers.empty?
questionnaire = self.questionnaire_by_answer(answers.first)

unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
supplementary_review_questions = supplementary_review_questionnaire.questions.sort_by(&:seq)
end

questionnaire_max = questionnaire.max_question_score
questions = questionnaire.questions.sort_by(&:seq)

unless supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end

# get the tag settings this questionnaire
tag_prompt_deployments = show_tags ? TagPromptDeployment.where(questionnaire_id: questionnaire.id, assignment_id: self.map.assignment.id) : nil
code = add_table_rows questionnaire_max, questions, answers, code, tag_prompt_deployments, current_user
end
comment = if !self.additional_comment.nil?
self.additional_comment.gsub('^p', '').gsub(/\n/, '<BR/>')
else
''
end
code += '<tr><td><b>Additional Comment: </b>' + comment + '</td></tr>'
code += '</table>'
end
</pre>

2. Views:

app/views/assignments/edit/_rubrics.html.erb

Add checkbox which professor used to indicate whether students can create their own questions.

<pre>

<input name="assignment_form[assignment][supplementary_review_questionnaire]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'true', @assignment_form.assignment.supplementary_review_questionnaire) %>
<%= label_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'Allow student-generated questions added to rubric?') %>
</pre>

app/views/response/response.html.erb

Add code to show the supplementary questions to the reviewers.

<pre>
<br>
<% unless @supplementary_review_questions.nil? %>
<tr>
<td>
<h2>Supplementary Review Questions</h2>
</td>
</tr>
<% @supplementary_review_questions.each do |question| %>
<tr>
<td>
<% answer = Answer.where(question_id: question.id, response_id: @response.id).first if !@response.nil? %>
<% if question.instance_of? Criterion %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score, @dropdown_or_scale) %>
<%= tinymce %>
<% elsif question.instance_of? Scale %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score) %>
<%= tinymce %>
<% elsif question.instance_of? UploadFile %>
<% else %>
<%= question.complete(i, answer) %>
<% end %>
</td>
<td width="25%">
<% if [Criterion, TextArea].include? question.class %>
<div id="analysis_<%= i.to_s %>_comments"></div>
<% end %>
</td>
</tr>
<% i += 1 %>
<% end %>
<% end %>
</pre>

app/views/submitted_content/_main.html.erb

Add button for "your work" page to let students create their own questions.

<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.supplementary_review_questionnaire? %>
<%= button_to "Create Supplementary Rubric", {:controller => "questionnaires", :action => "create_supplementary_review_questionnaire", :id => participant.id } %>
<% else %>
The instructor hasn't enabled this feature for this assignment
<% end %>
<% end %>
</pre>

3. Controllers:

app/controllers/response_controller.rb

Add supplementary review questionnaires part to the create, edit, update methods and some other methods which getting the questionnaires.

<pre>
# Prepare the parameters when student clicks "Edit"
def edit
assign_instance_vars
get_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i && m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@supplementary_review_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@questionnaire = set_questionnaire
render action: 'response'
end

# Update the response and answers when student "edit" existing response
def update
render nothing: true unless action_allowed?
# the response to be updated
@response = Response.find(params[:id])
msg = ""
begin
@map = @response.map
@response.update_attribute('additional_comment', params[:review][:comments])

set_questionnaire
questions = sort_questions(@questionnaire.questions)
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
unless @supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end
create_answers(params, questions) unless params[:responses].nil?

@response.update_attribute('is_submitted', true) if params['isSubmit'] && params['isSubmit'] == 'Yes'
@response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
rescue StandardError
msg = "Your response was not saved. Cause:189 #{$ERROR_INFO}"
end
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Your response was submitted: #{@response.is_submitted}", request)
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, review: params[:review], save_options: params[:save_options]
end

def create
map_id = params[:id]
map_id = params[:map_id] unless params[:map_id].nil? # pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
@team_id = @map.reviewee_id

get_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')
was_submitted = false
@response = Response.where(map_id: @map.id, round: @round.to_i).first
if @response.nil?
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round.to_i,
is_submitted: is_submitted
)
end
was_submitted = @response.is_submitted
@response.update(additional_comment: params[:review][:comments], is_submitted: is_submitted) # ignore if autoupdate try to save when the response object is not yet created.

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
questions += supplementary_review_questions
end

create_answers(params, questions) if params[:responses]
msg = "Your response was successfully saved."
error_msg = ""
# only notify if is_submitted changes from false to true
if (@map.is_a? ReviewResponseMap) && (was_submitted == false && @response.is_submitted) && @response.significant_difference?
@response.notify_instructor_on_difference
@response.email
end
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, error_msg: error_msg, review: params[:review], save_options: params[:save_options]
end

# new_response if a flag parameter indicating that if user is requesting a new rubric to fill
# if true: we figure out which questionnaire to use based on current time and records in assignment_questionnaires table
# e.g. student click "Begin" or "Update" to start filling out a rubric for others' work
# if false: we figure out which questionnaire to display base on @response object
# e.g. student click "Edit" or "View"
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
@supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
end

@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end

def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)

@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@contributor.id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end

when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)

supplementary_review_answer = @response.scores.last
@supplementary_review_questionnaire = @response.questionnaire_by_answer(supplementary_review_answer)

end

</pre>

app/controllers/grades_controller.rb

Add supplementary review responses to "Your Scores" section.

<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
counter_for_same_rubric = 0
questionnaires.each do |questionnaire|
@round = nil
if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
unless supplementary_review_questionnaire.nil?
supplementary_review_questions = supplementary_review_questionnaire.questions
questionnaire.questions += supplementary_review_questions
end
end
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>

app/controllers/questionnaires_controller.rb

Method for creating Supplementary Review Questionnaire.

<pre>
def create_supplementary_review_questionnaire
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.supplementary_review_questionnaire_id.nil?
@questionnaire = Questionnaire.create(privete: false, name: "supplementary_review_questionnaire_" + @team.id.to_s,
instructor_id: @team_id, min_question_score: 0, max_question_score: 5, type: "Questionnaire", display_type: "Review"
instruction_loc: Questionnaire::DEFAULT_QUESTIONNAIRE_URL)
if @questionnaire.save
@team.supplementary_review_questionnaire_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a rubric!'
else
flash[:error] = $ERROR_INFO
end
else
@questionnaire = Questionnaire.find(@team.supplementary_review_questionnaire_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end
</pre>

4. Config:

routes.rb
<pre>

resources :questionnaires, only: %i[new create edit update] do
collection do
get :copy
get :list
post :list_questionnaires
get :new_quiz
get :select_questionnaire_type
post :select_questionnaire_type
get :toggle_access
get :view
post :create_quiz_questionnaire
post :update_quiz
post :add_new_questions
post :save_all_questions
post :create_supplementary_review_questionnaire
end
end

resources :author_feedback_questionnaires, controller: :questionnaires
resources :review_questionnaires, controller: :questionnaires
resources :metareview_questionnaires, controller: :questionnaires
resources :teammate_review_questionnaires, controller: :questionnaires
resources :survey_questionnaires, controller: :questionnaires
resources :assignment_survey_questionnaires, controller: :questionnaires
resources :global_survey_questionnaires, controller: :questionnaires
resources :course_survey_questionnaires, controller: :questionnaires
resources :bookmarkrating_questionnaires, controller: :questionnaires
resources :supplementary_review_questionnaire, controller: :questionnaires
</pre>

'''Team members'''
----
Yanchen Zhao

Pingping Chen

Jianshu Zhang

Zirun Han

'''Links'''
----
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T01:43:06Z

Hcao5:

==Introduction==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

==Proposed solution==
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

== Implementation ==

''Design Strategy''

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

''Changes in the User Interface''

1. Assignment Page

We add a checkbox for the professor to indicate if student can add their own questions.

2. A button called "Create Supplementary Rubric" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the button he/she can add the desired questions.

3. The page where student will be directed to when he/she clicks the Create Supplementary Rubric button. Students can add Questions to the created Supplementary Review questionnaire here.

4. Review Page

The students own supplementary questions are leading by a heading "Supplementary Review Questions".

5. Review Results Page

The supplementary review results will be showed to the team like other results.

'''Use Cases'''
----

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

'''Test Plan'''
----
Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

'''File which are added/modified'''
----

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

1. Models

app/models/team.rb

Look up the questionnaire ID of a team.

<pre>
def self.get_supplementary_review_questionnaire_id_of_team(team_id)
team = Team.find(team_id)
if team.blank?
nil
else
team.supplementary_review_questionnaire_id
end
end
</pre>

app/models/supplementary_review_questionnaire.rb

Add the SupplementaryReviewQuestionnaire class which is the subclass of Questionnaire.

<pre>

# This is one type of Questionnaire and as intuitively expected this model class
# derives from Questionnaire.
class SupplementaryReviewQuestionnaire < Questionnaire
# Make me better.
attr_accessible
end
</pre>

app/models/response.rb

Add supplementary review responses to "Show Review" section.

<pre>
def construct_review_response code, self_id, show_tags = nil, current_user = nil
code += '<table id="review_' + self_id + '" style="display: none;" class="table table-bordered">'
answers = Answer.where(response_id: self.response_id)
team_id = response_map.reviewee_id
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(team_id)
unless answers.empty?
questionnaire = self.questionnaire_by_answer(answers.first)

unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
supplementary_review_questions = supplementary_review_questionnaire.questions.sort_by(&:seq)
end

questionnaire_max = questionnaire.max_question_score
questions = questionnaire.questions.sort_by(&:seq)

unless supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end

# get the tag settings this questionnaire
tag_prompt_deployments = show_tags ? TagPromptDeployment.where(questionnaire_id: questionnaire.id, assignment_id: self.map.assignment.id) : nil
code = add_table_rows questionnaire_max, questions, answers, code, tag_prompt_deployments, current_user
end
comment = if !self.additional_comment.nil?
self.additional_comment.gsub('^p', '').gsub(/\n/, '<BR/>')
else
''
end
code += '<tr><td><b>Additional Comment: </b>' + comment + '</td></tr>'
code += '</table>'
end
</pre>

2. Views:

app/views/assignments/edit/_rubrics.html.erb

Add checkbox which professor used to indicate whether students can create their own questions.

<pre>

<input name="assignment_form[assignment][supplementary_review_questionnaire]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'true', @assignment_form.assignment.supplementary_review_questionnaire) %>
<%= label_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'Allow student-generated questions added to rubric?') %>
</pre>

app/views/response/response.html.erb

Add code to show the supplementary questions to the reviewers.

<pre>
<br>
<% unless @supplementary_review_questions.nil? %>
<tr>
<td>
<h2>Supplementary Review Questions</h2>
</td>
</tr>
<% @supplementary_review_questions.each do |question| %>
<tr>
<td>
<% answer = Answer.where(question_id: question.id, response_id: @response.id).first if !@response.nil? %>
<% if question.instance_of? Criterion %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score, @dropdown_or_scale) %>
<%= tinymce %>
<% elsif question.instance_of? Scale %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score) %>
<%= tinymce %>
<% elsif question.instance_of? UploadFile %>
<% else %>
<%= question.complete(i, answer) %>
<% end %>
</td>
<td width="25%">
<% if [Criterion, TextArea].include? question.class %>
<div id="analysis_<%= i.to_s %>_comments"></div>
<% end %>
</td>
</tr>
<% i += 1 %>
<% end %>
<% end %>
</pre>

app/views/submitted_content/_main.html.erb

Add button for "your work" page to let students create their own questions.

<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.supplementary_review_questionnaire? %>
<%= button_to "Create Supplementary Rubric", {:controller => "questionnaires", :action => "create_supplementary_review_questionnaire", :id => participant.id } %>
<% else %>
The instructor hasn't enabled this feature for this assignment
<% end %>
<% end %>
</pre>

3. Controllers:

app/controllers/response_controller.rb

Add supplementary review questionnaires part to the create, edit, update methods and some other methods which getting the questionnaires.

<pre>
# Prepare the parameters when student clicks "Edit"
def edit
assign_instance_vars
get_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i && m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@supplementary_review_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@questionnaire = set_questionnaire
render action: 'response'
end

# Update the response and answers when student "edit" existing response
def update
render nothing: true unless action_allowed?
# the response to be updated
@response = Response.find(params[:id])
msg = ""
begin
@map = @response.map
@response.update_attribute('additional_comment', params[:review][:comments])

set_questionnaire
questions = sort_questions(@questionnaire.questions)
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
unless @supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end
create_answers(params, questions) unless params[:responses].nil?

@response.update_attribute('is_submitted', true) if params['isSubmit'] && params['isSubmit'] == 'Yes'
@response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
rescue StandardError
msg = "Your response was not saved. Cause:189 #{$ERROR_INFO}"
end
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Your response was submitted: #{@response.is_submitted}", request)
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, review: params[:review], save_options: params[:save_options]
end

def create
map_id = params[:id]
map_id = params[:map_id] unless params[:map_id].nil? # pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
@team_id = @map.reviewee_id

get_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')
was_submitted = false
@response = Response.where(map_id: @map.id, round: @round.to_i).first
if @response.nil?
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round.to_i,
is_submitted: is_submitted
)
end
was_submitted = @response.is_submitted
@response.update(additional_comment: params[:review][:comments], is_submitted: is_submitted) # ignore if autoupdate try to save when the response object is not yet created.

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
questions += supplementary_review_questions
end

create_answers(params, questions) if params[:responses]
msg = "Your response was successfully saved."
error_msg = ""
# only notify if is_submitted changes from false to true
if (@map.is_a? ReviewResponseMap) && (was_submitted == false && @response.is_submitted) && @response.significant_difference?
@response.notify_instructor_on_difference
@response.email
end
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, error_msg: error_msg, review: params[:review], save_options: params[:save_options]
end

# new_response if a flag parameter indicating that if user is requesting a new rubric to fill
# if true: we figure out which questionnaire to use based on current time and records in assignment_questionnaires table
# e.g. student click "Begin" or "Update" to start filling out a rubric for others' work
# if false: we figure out which questionnaire to display base on @response object
# e.g. student click "Edit" or "View"
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
@supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
end

@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end

def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)

@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@contributor.id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end

when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)

supplementary_review_answer = @response.scores.last
@supplementary_review_questionnaire = @response.questionnaire_by_answer(supplementary_review_answer)

end

</pre>

app/controllers/grades_controller.rb

Add supplementary review responses to "Your Scores" section.

<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
counter_for_same_rubric = 0
questionnaires.each do |questionnaire|
@round = nil
if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
unless supplementary_review_questionnaire.nil?
supplementary_review_questions = supplementary_review_questionnaire.questions
questionnaire.questions += supplementary_review_questions
end
end
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>

app/controllers/questionnaires_controller.rb

Method for creating Supplementary Review Questionnaire.

<pre>
def create_supplementary_review_questionnaire
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.supplementary_review_questionnaire_id.nil?
@questionnaire = Questionnaire.create(privete: false, name: "supplementary_review_questionnaire_" + @team.id.to_s,
instructor_id: @team_id, min_question_score: 0, max_question_score: 5, type: "Questionnaire", display_type: "Review"
instruction_loc: Questionnaire::DEFAULT_QUESTIONNAIRE_URL)
if @questionnaire.save
@team.supplementary_review_questionnaire_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a rubric!'
else
flash[:error] = $ERROR_INFO
end
else
@questionnaire = Questionnaire.find(@team.supplementary_review_questionnaire_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end
</pre>

4. Config:

routes.rb
<pre>

resources :questionnaires, only: %i[new create edit update] do
collection do
get :copy
get :list
post :list_questionnaires
get :new_quiz
get :select_questionnaire_type
post :select_questionnaire_type
get :toggle_access
get :view
post :create_quiz_questionnaire
post :update_quiz
post :add_new_questions
post :save_all_questions
post :create_supplementary_review_questionnaire
end
end

resources :author_feedback_questionnaires, controller: :questionnaires
resources :review_questionnaires, controller: :questionnaires
resources :metareview_questionnaires, controller: :questionnaires
resources :teammate_review_questionnaires, controller: :questionnaires
resources :survey_questionnaires, controller: :questionnaires
resources :assignment_survey_questionnaires, controller: :questionnaires
resources :global_survey_questionnaires, controller: :questionnaires
resources :course_survey_questionnaires, controller: :questionnaires
resources :bookmarkrating_questionnaires, controller: :questionnaires
resources :supplementary_review_questionnaire, controller: :questionnaires
</pre>

'''Team members'''
----
Yanchen Zhao

Pingping Chen

Jianshu Zhang

Zirun Han

'''Links'''
----
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T01:42:02Z

Hcao5:

==Introduction==
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

==Proposed solution==
We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

==Implementation==

''Design Strategy''

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

''Changes in the User Interface''

1. Assignment Page

We add a checkbox for the professor to indicate if student can add their own questions.

2. A button called "Create Supplementary Rubric" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the button he/she can add the desired questions.

3. The page where student will be directed to when he/she clicks the Create Supplementary Rubric button. Students can add Questions to the created Supplementary Review questionnaire here.

4. Review Page

The students own supplementary questions are leading by a heading "Supplementary Review Questions".

5. Review Results Page

The supplementary review results will be showed to the team like other results.

'''Use Cases'''
----

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

'''Test Plan'''
----
Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

'''File which are added/modified'''
----

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

1. Models

app/models/team.rb

Look up the questionnaire ID of a team.

<pre>
def self.get_supplementary_review_questionnaire_id_of_team(team_id)
team = Team.find(team_id)
if team.blank?
nil
else
team.supplementary_review_questionnaire_id
end
end
</pre>

app/models/supplementary_review_questionnaire.rb

Add the SupplementaryReviewQuestionnaire class which is the subclass of Questionnaire.

<pre>

# This is one type of Questionnaire and as intuitively expected this model class
# derives from Questionnaire.
class SupplementaryReviewQuestionnaire < Questionnaire
# Make me better.
attr_accessible
end
</pre>

app/models/response.rb

Add supplementary review responses to "Show Review" section.

<pre>
def construct_review_response code, self_id, show_tags = nil, current_user = nil
code += '<table id="review_' + self_id + '" style="display: none;" class="table table-bordered">'
answers = Answer.where(response_id: self.response_id)
team_id = response_map.reviewee_id
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(team_id)
unless answers.empty?
questionnaire = self.questionnaire_by_answer(answers.first)

unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
supplementary_review_questions = supplementary_review_questionnaire.questions.sort_by(&:seq)
end

questionnaire_max = questionnaire.max_question_score
questions = questionnaire.questions.sort_by(&:seq)

unless supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end

# get the tag settings this questionnaire
tag_prompt_deployments = show_tags ? TagPromptDeployment.where(questionnaire_id: questionnaire.id, assignment_id: self.map.assignment.id) : nil
code = add_table_rows questionnaire_max, questions, answers, code, tag_prompt_deployments, current_user
end
comment = if !self.additional_comment.nil?
self.additional_comment.gsub('^p', '').gsub(/\n/, '<BR/>')
else
''
end
code += '<tr><td><b>Additional Comment: </b>' + comment + '</td></tr>'
code += '</table>'
end
</pre>

2. Views:

app/views/assignments/edit/_rubrics.html.erb

Add checkbox which professor used to indicate whether students can create their own questions.

<pre>

<input name="assignment_form[assignment][supplementary_review_questionnaire]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'true', @assignment_form.assignment.supplementary_review_questionnaire) %>
<%= label_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'Allow student-generated questions added to rubric?') %>
</pre>

app/views/response/response.html.erb

Add code to show the supplementary questions to the reviewers.

<pre>
<br>
<% unless @supplementary_review_questions.nil? %>
<tr>
<td>
<h2>Supplementary Review Questions</h2>
</td>
</tr>
<% @supplementary_review_questions.each do |question| %>
<tr>
<td>
<% answer = Answer.where(question_id: question.id, response_id: @response.id).first if !@response.nil? %>
<% if question.instance_of? Criterion %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score, @dropdown_or_scale) %>
<%= tinymce %>
<% elsif question.instance_of? Scale %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score) %>
<%= tinymce %>
<% elsif question.instance_of? UploadFile %>
<% else %>
<%= question.complete(i, answer) %>
<% end %>
</td>
<td width="25%">
<% if [Criterion, TextArea].include? question.class %>
<div id="analysis_<%= i.to_s %>_comments"></div>
<% end %>
</td>
</tr>
<% i += 1 %>
<% end %>
<% end %>
</pre>

app/views/submitted_content/_main.html.erb

Add button for "your work" page to let students create their own questions.

<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.supplementary_review_questionnaire? %>
<%= button_to "Create Supplementary Rubric", {:controller => "questionnaires", :action => "create_supplementary_review_questionnaire", :id => participant.id } %>
<% else %>
The instructor hasn't enabled this feature for this assignment
<% end %>
<% end %>
</pre>

3. Controllers:

app/controllers/response_controller.rb

Add supplementary review questionnaires part to the create, edit, update methods and some other methods which getting the questionnaires.

<pre>
# Prepare the parameters when student clicks "Edit"
def edit
assign_instance_vars
get_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i && m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@supplementary_review_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@questionnaire = set_questionnaire
render action: 'response'
end

# Update the response and answers when student "edit" existing response
def update
render nothing: true unless action_allowed?
# the response to be updated
@response = Response.find(params[:id])
msg = ""
begin
@map = @response.map
@response.update_attribute('additional_comment', params[:review][:comments])

set_questionnaire
questions = sort_questions(@questionnaire.questions)
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
unless @supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end
create_answers(params, questions) unless params[:responses].nil?

@response.update_attribute('is_submitted', true) if params['isSubmit'] && params['isSubmit'] == 'Yes'
@response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
rescue StandardError
msg = "Your response was not saved. Cause:189 #{$ERROR_INFO}"
end
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Your response was submitted: #{@response.is_submitted}", request)
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, review: params[:review], save_options: params[:save_options]
end

def create
map_id = params[:id]
map_id = params[:map_id] unless params[:map_id].nil? # pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
@team_id = @map.reviewee_id

get_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')
was_submitted = false
@response = Response.where(map_id: @map.id, round: @round.to_i).first
if @response.nil?
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round.to_i,
is_submitted: is_submitted
)
end
was_submitted = @response.is_submitted
@response.update(additional_comment: params[:review][:comments], is_submitted: is_submitted) # ignore if autoupdate try to save when the response object is not yet created.

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
questions += supplementary_review_questions
end

create_answers(params, questions) if params[:responses]
msg = "Your response was successfully saved."
error_msg = ""
# only notify if is_submitted changes from false to true
if (@map.is_a? ReviewResponseMap) && (was_submitted == false && @response.is_submitted) && @response.significant_difference?
@response.notify_instructor_on_difference
@response.email
end
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, error_msg: error_msg, review: params[:review], save_options: params[:save_options]
end

# new_response if a flag parameter indicating that if user is requesting a new rubric to fill
# if true: we figure out which questionnaire to use based on current time and records in assignment_questionnaires table
# e.g. student click "Begin" or "Update" to start filling out a rubric for others' work
# if false: we figure out which questionnaire to display base on @response object
# e.g. student click "Edit" or "View"
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
@supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
end

@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end

def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)

@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@contributor.id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end

when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)

supplementary_review_answer = @response.scores.last
@supplementary_review_questionnaire = @response.questionnaire_by_answer(supplementary_review_answer)

end

</pre>

app/controllers/grades_controller.rb

Add supplementary review responses to "Your Scores" section.

<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
counter_for_same_rubric = 0
questionnaires.each do |questionnaire|
@round = nil
if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
unless supplementary_review_questionnaire.nil?
supplementary_review_questions = supplementary_review_questionnaire.questions
questionnaire.questions += supplementary_review_questions
end
end
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>

app/controllers/questionnaires_controller.rb

Method for creating Supplementary Review Questionnaire.

<pre>
def create_supplementary_review_questionnaire
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.supplementary_review_questionnaire_id.nil?
@questionnaire = Questionnaire.create(privete: false, name: "supplementary_review_questionnaire_" + @team.id.to_s,
instructor_id: @team_id, min_question_score: 0, max_question_score: 5, type: "Questionnaire", display_type: "Review"
instruction_loc: Questionnaire::DEFAULT_QUESTIONNAIRE_URL)
if @questionnaire.save
@team.supplementary_review_questionnaire_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a rubric!'
else
flash[:error] = $ERROR_INFO
end
else
@questionnaire = Questionnaire.find(@team.supplementary_review_questionnaire_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end
</pre>

4. Config:

routes.rb
<pre>

resources :questionnaires, only: %i[new create edit update] do
collection do
get :copy
get :list
post :list_questionnaires
get :new_quiz
get :select_questionnaire_type
post :select_questionnaire_type
get :toggle_access
get :view
post :create_quiz_questionnaire
post :update_quiz
post :add_new_questions
post :save_all_questions
post :create_supplementary_review_questionnaire
end
end

resources :author_feedback_questionnaires, controller: :questionnaires
resources :review_questionnaires, controller: :questionnaires
resources :metareview_questionnaires, controller: :questionnaires
resources :teammate_review_questionnaires, controller: :questionnaires
resources :survey_questionnaires, controller: :questionnaires
resources :assignment_survey_questionnaires, controller: :questionnaires
resources :global_survey_questionnaires, controller: :questionnaires
resources :course_survey_questionnaires, controller: :questionnaires
resources :bookmarkrating_questionnaires, controller: :questionnaires
resources :supplementary_review_questionnaire, controller: :questionnaires
</pre>

'''Team members'''
----
Yanchen Zhao

Pingping Chen

Jianshu Zhang

Zirun Han

'''Links'''
----
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T01:41:26Z

Hcao5:

==Introduction==
----
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

'''Proposed solution'''
----

We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

'''Implementation'''
----

''Design Strategy''

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

''Changes in the User Interface''

1. Assignment Page

We add a checkbox for the professor to indicate if student can add their own questions.

2. A button called "Create Supplementary Rubric" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the button he/she can add the desired questions.

3. The page where student will be directed to when he/she clicks the Create Supplementary Rubric button. Students can add Questions to the created Supplementary Review questionnaire here.

4. Review Page

The students own supplementary questions are leading by a heading "Supplementary Review Questions".

5. Review Results Page

The supplementary review results will be showed to the team like other results.

'''Use Cases'''
----

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

'''Test Plan'''
----
Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

'''File which are added/modified'''
----

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

1. Models

app/models/team.rb

Look up the questionnaire ID of a team.

<pre>
def self.get_supplementary_review_questionnaire_id_of_team(team_id)
team = Team.find(team_id)
if team.blank?
nil
else
team.supplementary_review_questionnaire_id
end
end
</pre>

app/models/supplementary_review_questionnaire.rb

Add the SupplementaryReviewQuestionnaire class which is the subclass of Questionnaire.

<pre>

# This is one type of Questionnaire and as intuitively expected this model class
# derives from Questionnaire.
class SupplementaryReviewQuestionnaire < Questionnaire
# Make me better.
attr_accessible
end
</pre>

app/models/response.rb

Add supplementary review responses to "Show Review" section.

<pre>
def construct_review_response code, self_id, show_tags = nil, current_user = nil
code += '<table id="review_' + self_id + '" style="display: none;" class="table table-bordered">'
answers = Answer.where(response_id: self.response_id)
team_id = response_map.reviewee_id
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(team_id)
unless answers.empty?
questionnaire = self.questionnaire_by_answer(answers.first)

unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
supplementary_review_questions = supplementary_review_questionnaire.questions.sort_by(&:seq)
end

questionnaire_max = questionnaire.max_question_score
questions = questionnaire.questions.sort_by(&:seq)

unless supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end

# get the tag settings this questionnaire
tag_prompt_deployments = show_tags ? TagPromptDeployment.where(questionnaire_id: questionnaire.id, assignment_id: self.map.assignment.id) : nil
code = add_table_rows questionnaire_max, questions, answers, code, tag_prompt_deployments, current_user
end
comment = if !self.additional_comment.nil?
self.additional_comment.gsub('^p', '').gsub(/\n/, '<BR/>')
else
''
end
code += '<tr><td><b>Additional Comment: </b>' + comment + '</td></tr>'
code += '</table>'
end
</pre>

2. Views:

app/views/assignments/edit/_rubrics.html.erb

Add checkbox which professor used to indicate whether students can create their own questions.

<pre>

<input name="assignment_form[assignment][supplementary_review_questionnaire]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'true', @assignment_form.assignment.supplementary_review_questionnaire) %>
<%= label_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'Allow student-generated questions added to rubric?') %>
</pre>

app/views/response/response.html.erb

Add code to show the supplementary questions to the reviewers.

<pre>
<br>
<% unless @supplementary_review_questions.nil? %>
<tr>
<td>
<h2>Supplementary Review Questions</h2>
</td>
</tr>
<% @supplementary_review_questions.each do |question| %>
<tr>
<td>
<% answer = Answer.where(question_id: question.id, response_id: @response.id).first if !@response.nil? %>
<% if question.instance_of? Criterion %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score, @dropdown_or_scale) %>
<%= tinymce %>
<% elsif question.instance_of? Scale %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score) %>
<%= tinymce %>
<% elsif question.instance_of? UploadFile %>
<% else %>
<%= question.complete(i, answer) %>
<% end %>
</td>
<td width="25%">
<% if [Criterion, TextArea].include? question.class %>
<div id="analysis_<%= i.to_s %>_comments"></div>
<% end %>
</td>
</tr>
<% i += 1 %>
<% end %>
<% end %>
</pre>

app/views/submitted_content/_main.html.erb

Add button for "your work" page to let students create their own questions.

<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.supplementary_review_questionnaire? %>
<%= button_to "Create Supplementary Rubric", {:controller => "questionnaires", :action => "create_supplementary_review_questionnaire", :id => participant.id } %>
<% else %>
The instructor hasn't enabled this feature for this assignment
<% end %>
<% end %>
</pre>

3. Controllers:

app/controllers/response_controller.rb

Add supplementary review questionnaires part to the create, edit, update methods and some other methods which getting the questionnaires.

<pre>
# Prepare the parameters when student clicks "Edit"
def edit
assign_instance_vars
get_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i && m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@supplementary_review_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@questionnaire = set_questionnaire
render action: 'response'
end

# Update the response and answers when student "edit" existing response
def update
render nothing: true unless action_allowed?
# the response to be updated
@response = Response.find(params[:id])
msg = ""
begin
@map = @response.map
@response.update_attribute('additional_comment', params[:review][:comments])

set_questionnaire
questions = sort_questions(@questionnaire.questions)
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
unless @supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end
create_answers(params, questions) unless params[:responses].nil?

@response.update_attribute('is_submitted', true) if params['isSubmit'] && params['isSubmit'] == 'Yes'
@response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
rescue StandardError
msg = "Your response was not saved. Cause:189 #{$ERROR_INFO}"
end
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Your response was submitted: #{@response.is_submitted}", request)
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, review: params[:review], save_options: params[:save_options]
end

def create
map_id = params[:id]
map_id = params[:map_id] unless params[:map_id].nil? # pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
@team_id = @map.reviewee_id

get_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')
was_submitted = false
@response = Response.where(map_id: @map.id, round: @round.to_i).first
if @response.nil?
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round.to_i,
is_submitted: is_submitted
)
end
was_submitted = @response.is_submitted
@response.update(additional_comment: params[:review][:comments], is_submitted: is_submitted) # ignore if autoupdate try to save when the response object is not yet created.

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
questions += supplementary_review_questions
end

create_answers(params, questions) if params[:responses]
msg = "Your response was successfully saved."
error_msg = ""
# only notify if is_submitted changes from false to true
if (@map.is_a? ReviewResponseMap) && (was_submitted == false && @response.is_submitted) && @response.significant_difference?
@response.notify_instructor_on_difference
@response.email
end
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, error_msg: error_msg, review: params[:review], save_options: params[:save_options]
end

# new_response if a flag parameter indicating that if user is requesting a new rubric to fill
# if true: we figure out which questionnaire to use based on current time and records in assignment_questionnaires table
# e.g. student click "Begin" or "Update" to start filling out a rubric for others' work
# if false: we figure out which questionnaire to display base on @response object
# e.g. student click "Edit" or "View"
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
@supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
end

@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end

def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)

@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@contributor.id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end

when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)

supplementary_review_answer = @response.scores.last
@supplementary_review_questionnaire = @response.questionnaire_by_answer(supplementary_review_answer)

end

</pre>

app/controllers/grades_controller.rb

Add supplementary review responses to "Your Scores" section.

<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
counter_for_same_rubric = 0
questionnaires.each do |questionnaire|
@round = nil
if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
unless supplementary_review_questionnaire.nil?
supplementary_review_questions = supplementary_review_questionnaire.questions
questionnaire.questions += supplementary_review_questions
end
end
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>

app/controllers/questionnaires_controller.rb

Method for creating Supplementary Review Questionnaire.

<pre>
def create_supplementary_review_questionnaire
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.supplementary_review_questionnaire_id.nil?
@questionnaire = Questionnaire.create(privete: false, name: "supplementary_review_questionnaire_" + @team.id.to_s,
instructor_id: @team_id, min_question_score: 0, max_question_score: 5, type: "Questionnaire", display_type: "Review"
instruction_loc: Questionnaire::DEFAULT_QUESTIONNAIRE_URL)
if @questionnaire.save
@team.supplementary_review_questionnaire_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a rubric!'
else
flash[:error] = $ERROR_INFO
end
else
@questionnaire = Questionnaire.find(@team.supplementary_review_questionnaire_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end
</pre>

4. Config:

routes.rb
<pre>

resources :questionnaires, only: %i[new create edit update] do
collection do
get :copy
get :list
post :list_questionnaires
get :new_quiz
get :select_questionnaire_type
post :select_questionnaire_type
get :toggle_access
get :view
post :create_quiz_questionnaire
post :update_quiz
post :add_new_questions
post :save_all_questions
post :create_supplementary_review_questionnaire
end
end

resources :author_feedback_questionnaires, controller: :questionnaires
resources :review_questionnaires, controller: :questionnaires
resources :metareview_questionnaires, controller: :questionnaires
resources :teammate_review_questionnaires, controller: :questionnaires
resources :survey_questionnaires, controller: :questionnaires
resources :assignment_survey_questionnaires, controller: :questionnaires
resources :global_survey_questionnaires, controller: :questionnaires
resources :course_survey_questionnaires, controller: :questionnaires
resources :bookmarkrating_questionnaires, controller: :questionnaires
resources :supplementary_review_questionnaire, controller: :questionnaires
</pre>

'''Team members'''
----
Yanchen Zhao

Pingping Chen

Jianshu Zhang

Zirun Han

'''Links'''
----
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-11T00:11:52Z

Hcao5:

'''Introduction'''
----
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

'''Proposed solution'''
----

We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

'''Implementation'''
----

''Design Strategy''

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

''Changes in the User Interface''

1. Assignment Page

We add a checkbox for the professor to indicate if student can add their own questions.

2. A button called "Create Supplementary Rubric" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the button he/she can add the desired questions.

3. The page where student will be directed to when he/she clicks the Create Supplementary Rubric button. Students can add Questions to the created Supplementary Review questionnaire here.

4. Review Page

The students own supplementary questions are leading by a heading "Supplementary Review Questions".

5. Review Results Page

The supplementary review results will be showed to the team like other results.

'''Use Cases'''
----

1. Use case of creating a Supplementary Review Questionnaire

2. Use case of reviewing questions for reviewers.

3. Use case of reviewing responses of questions.

'''Test Plan'''
----
Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

'''File which are added/modified'''
----

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

1. Models

app/models/team.rb

Look up the questionnaire ID of a team.

<pre>
def self.get_supplementary_review_questionnaire_id_of_team(team_id)
team = Team.find(team_id)
if team.blank?
nil
else
team.supplementary_review_questionnaire_id
end
end
</pre>

app/models/supplementary_review_questionnaire.rb

Add the SupplementaryReviewQuestionnaire class which is the subclass of Questionnaire.

<pre>

# This is one type of Questionnaire and as intuitively expected this model class
# derives from Questionnaire.
class SupplementaryReviewQuestionnaire < Questionnaire
# Make me better.
attr_accessible
end
</pre>

app/models/response.rb

Add supplementary review responses to "Show Review" section.

<pre>
def construct_review_response code, self_id, show_tags = nil, current_user = nil
code += '<table id="review_' + self_id + '" style="display: none;" class="table table-bordered">'
answers = Answer.where(response_id: self.response_id)
team_id = response_map.reviewee_id
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(team_id)
unless answers.empty?
questionnaire = self.questionnaire_by_answer(answers.first)

unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
supplementary_review_questions = supplementary_review_questionnaire.questions.sort_by(&:seq)
end

questionnaire_max = questionnaire.max_question_score
questions = questionnaire.questions.sort_by(&:seq)

unless supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end

# get the tag settings this questionnaire
tag_prompt_deployments = show_tags ? TagPromptDeployment.where(questionnaire_id: questionnaire.id, assignment_id: self.map.assignment.id) : nil
code = add_table_rows questionnaire_max, questions, answers, code, tag_prompt_deployments, current_user
end
comment = if !self.additional_comment.nil?
self.additional_comment.gsub('^p', '').gsub(/\n/, '<BR/>')
else
''
end
code += '<tr><td><b>Additional Comment: </b>' + comment + '</td></tr>'
code += '</table>'
end
</pre>

2. Views:

app/views/assignments/edit/_rubrics.html.erb

Add checkbox which professor used to indicate whether students can create their own questions.

<pre>

<input name="assignment_form[assignment][supplementary_review_questionnaire]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'true', @assignment_form.assignment.supplementary_review_questionnaire) %>
<%= label_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'Allow student-generated questions added to rubric?') %>
</pre>

app/views/response/response.html.erb

Add code to show the supplementary questions to the reviewers.

<pre>
<br>
<% unless @supplementary_review_questions.nil? %>
<tr>
<td>
<h2>Supplementary Review Questions</h2>
</td>
</tr>
<% @supplementary_review_questions.each do |question| %>
<tr>
<td>
<% answer = Answer.where(question_id: question.id, response_id: @response.id).first if !@response.nil? %>
<% if question.instance_of? Criterion %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score, @dropdown_or_scale) %>
<%= tinymce %>
<% elsif question.instance_of? Scale %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score) %>
<%= tinymce %>
<% elsif question.instance_of? UploadFile %>
<% else %>
<%= question.complete(i, answer) %>
<% end %>
</td>
<td width="25%">
<% if [Criterion, TextArea].include? question.class %>
<div id="analysis_<%= i.to_s %>_comments"></div>
<% end %>
</td>
</tr>
<% i += 1 %>
<% end %>
<% end %>
</pre>

app/views/submitted_content/_main.html.erb

Add button for "your work" page to let students create their own questions.

<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.supplementary_review_questionnaire? %>
<%= button_to "Create Supplementary Rubric", {:controller => "questionnaires", :action => "create_supplementary_review_questionnaire", :id => participant.id } %>
<% else %>
The instructor hasn't enabled this feature for this assignment
<% end %>
<% end %>
</pre>

3. Controllers:

app/controllers/response_controller.rb

Add supplementary review questionnaires part to the create, edit, update methods and some other methods which getting the questionnaires.

<pre>
# Prepare the parameters when student clicks "Edit"
def edit
assign_instance_vars
get_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i && m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@supplementary_review_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@questionnaire = set_questionnaire
render action: 'response'
end

# Update the response and answers when student "edit" existing response
def update
render nothing: true unless action_allowed?
# the response to be updated
@response = Response.find(params[:id])
msg = ""
begin
@map = @response.map
@response.update_attribute('additional_comment', params[:review][:comments])

set_questionnaire
questions = sort_questions(@questionnaire.questions)
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
unless @supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end
create_answers(params, questions) unless params[:responses].nil?

@response.update_attribute('is_submitted', true) if params['isSubmit'] && params['isSubmit'] == 'Yes'
@response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
rescue StandardError
msg = "Your response was not saved. Cause:189 #{$ERROR_INFO}"
end
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Your response was submitted: #{@response.is_submitted}", request)
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, review: params[:review], save_options: params[:save_options]
end

def create
map_id = params[:id]
map_id = params[:map_id] unless params[:map_id].nil? # pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
@team_id = @map.reviewee_id

get_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')
was_submitted = false
@response = Response.where(map_id: @map.id, round: @round.to_i).first
if @response.nil?
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round.to_i,
is_submitted: is_submitted
)
end
was_submitted = @response.is_submitted
@response.update(additional_comment: params[:review][:comments], is_submitted: is_submitted) # ignore if autoupdate try to save when the response object is not yet created.

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
questions += supplementary_review_questions
end

create_answers(params, questions) if params[:responses]
msg = "Your response was successfully saved."
error_msg = ""
# only notify if is_submitted changes from false to true
if (@map.is_a? ReviewResponseMap) && (was_submitted == false && @response.is_submitted) && @response.significant_difference?
@response.notify_instructor_on_difference
@response.email
end
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, error_msg: error_msg, review: params[:review], save_options: params[:save_options]
end

# new_response if a flag parameter indicating that if user is requesting a new rubric to fill
# if true: we figure out which questionnaire to use based on current time and records in assignment_questionnaires table
# e.g. student click "Begin" or "Update" to start filling out a rubric for others' work
# if false: we figure out which questionnaire to display base on @response object
# e.g. student click "Edit" or "View"
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
@supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
end

@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end

def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)

@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@contributor.id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end

when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)

supplementary_review_answer = @response.scores.last
@supplementary_review_questionnaire = @response.questionnaire_by_answer(supplementary_review_answer)

end

</pre>

app/controllers/grades_controller.rb

Add supplementary review responses to "Your Scores" section.

<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
counter_for_same_rubric = 0
questionnaires.each do |questionnaire|
@round = nil
if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
unless supplementary_review_questionnaire.nil?
supplementary_review_questions = supplementary_review_questionnaire.questions
questionnaire.questions += supplementary_review_questions
end
end
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>

app/controllers/questionnaires_controller.rb

Method for creating Supplementary Review Questionnaire.

<pre>
def create_supplementary_review_questionnaire
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.supplementary_review_questionnaire_id.nil?
@questionnaire = Questionnaire.create(privete: false, name: "supplementary_review_questionnaire_" + @team.id.to_s,
instructor_id: @team_id, min_question_score: 0, max_question_score: 5, type: "Questionnaire", display_type: "Review"
instruction_loc: Questionnaire::DEFAULT_QUESTIONNAIRE_URL)
if @questionnaire.save
@team.supplementary_review_questionnaire_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a rubric!'
else
flash[:error] = $ERROR_INFO
end
else
@questionnaire = Questionnaire.find(@team.supplementary_review_questionnaire_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end
</pre>

4. Config:

routes.rb
<pre>

resources :questionnaires, only: %i[new create edit update] do
collection do
get :copy
get :list
post :list_questionnaires
get :new_quiz
get :select_questionnaire_type
post :select_questionnaire_type
get :toggle_access
get :view
post :create_quiz_questionnaire
post :update_quiz
post :add_new_questions
post :save_all_questions
post :create_supplementary_review_questionnaire
end
end

resources :author_feedback_questionnaires, controller: :questionnaires
resources :review_questionnaires, controller: :questionnaires
resources :metareview_questionnaires, controller: :questionnaires
resources :teammate_review_questionnaires, controller: :questionnaires
resources :survey_questionnaires, controller: :questionnaires
resources :assignment_survey_questionnaires, controller: :questionnaires
resources :global_survey_questionnaires, controller: :questionnaires
resources :course_survey_questionnaires, controller: :questionnaires
resources :bookmarkrating_questionnaires, controller: :questionnaires
resources :supplementary_review_questionnaire, controller: :questionnaires
</pre>

'''Team members'''
----
Yanchen Zhao

Pingping Chen

Jianshu Zhang

Zirun Han

'''Links'''
----
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019 - E1981. Student-generated questions added to rubric

2019-11-10T22:48:28Z

Hcao5: Created page with "'''Introduction''' ---- The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supp..."

'''Introduction'''
----
The rubrics in expertiza are created by instructors. These Rubrics only contain questions that are related to the existed topics. Now, Expertiza only supports students to pull questionnaires is specific rubrics to get some help. Even that they can ask about anything that is relevant to all the projects that will be submitted But when students encounter difficult problems which are not in the existed topics, and they want to get special advice on that new field, the demand for creating supplementary review questionnaire raises. This project (E1879) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

'''Proposed solution'''
----

We will add the Supplementary Review Questions to the current Review Questions, and show these student-generated questions under the rubric given by instructor. Even though these questions won't be graded, they will eventually provide diversity for feedback. It will increase the benefit that each team gets because they can get feedback that is specific to their project.

'''Implementation'''
----

''Design Strategy''

In Expertiza, all kinds of rubrics and surveys are subclasses of Questionnaire. A Questionnaire can contain “questions” of several types (e.g., checkboxes, dropdowns, text boxes). So that we will add a new subclass of Questionnaire named SupplementaryReviewQuestionnaire to achieve our goal.

First, we want the professor to control if the students can create their own supplementary questions by using a checkbox to indicate. If the professor allow students to create their own questions, there will be a button in the students "Your work" page which can let the students jump to the same page that an instructor lands on when creating a new rubric. Then we will add the questionnaire id of this new SupplementaryReviewQuestionnaire to the Team table when students create their own questionnaire in order to show the corresponding supplementary questions to the reviewers. And when showing review questions to the reviewers we will look up the questionnaire id in Team table and modify the view to add the supplementary questions to review page. Finally, after the reviewers finish the review and submit their responds, we will change the view and let the team member can see the feedback of their supplementary questions.

''Changes in the User Interface''

1. Assignment Page

We add a checkbox for the professor to indicate if student can add their own questions.

[[File:Yzhao47_1.png]]

2. A button called "Create Supplementary Rubric" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the button he/she can add the desired questions.

[[File:Yzhao47_2.png]]

3. The page where student will be directed to when he/she clicks the Create Supplementary Rubric button. Students can add Questions to the created Supplementary Review questionnaire here.

[[File:Yzhao47_3.png]]

4. Review Page

The students own supplementary questions are leading by a heading "Supplementary Review Questions".

[[File:Yzhao47_4.png]]

5. Review Results Page

The supplementary review results will be showed to the team like other results.

[[File:Yzhao47_5.png]]

'''Use Cases'''
----

1. Use case of creating a Supplementary Review Questionnaire

[[File:case1.jpg]]

2. Use case of reviewing questions for reviewers.

[[File:case2.jpg]]

3. Use case of reviewing responses of questions.

[[File:case3.jpg]]

'''Test Plan'''
----
Actually, we need to add tests for the following:

1. To check the link for "Supplementary Review Questionnaire" appears in the "Your Work" section of a student.

2. To check if the link for "Supplementary Review Questionnaire" redirects to page which allows to create questionnaire.

3. To check if the questionnaire ID is stored in the Team table.

4. To check if the reviewers can see the supplementary questions that were added by the team as part of the review questions.

5. To check if the responses of the Supplementary Review Questions have been added to the responses of the existing review questions.

'''File which are added/modified'''
----

Note: Because the pull request contains some code irrelevant to this project which make it confusing, we post our code here for you to read clearly.

1. Models

app/models/team.rb

Look up the questionnaire ID of a team.

<pre>
def self.get_supplementary_review_questionnaire_id_of_team(team_id)
team = Team.find(team_id)
if team.blank?
nil
else
team.supplementary_review_questionnaire_id
end
end
</pre>

app/models/supplementary_review_questionnaire.rb

Add the SupplementaryReviewQuestionnaire class which is the subclass of Questionnaire.

<pre>

# This is one type of Questionnaire and as intuitively expected this model class
# derives from Questionnaire.
class SupplementaryReviewQuestionnaire < Questionnaire
# Make me better.
attr_accessible
end
</pre>

app/models/response.rb

Add supplementary review responses to "Show Review" section.

<pre>
def construct_review_response code, self_id, show_tags = nil, current_user = nil
code += '<table id="review_' + self_id + '" style="display: none;" class="table table-bordered">'
answers = Answer.where(response_id: self.response_id)
team_id = response_map.reviewee_id
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(team_id)
unless answers.empty?
questionnaire = self.questionnaire_by_answer(answers.first)

unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
supplementary_review_questions = supplementary_review_questionnaire.questions.sort_by(&:seq)
end

questionnaire_max = questionnaire.max_question_score
questions = questionnaire.questions.sort_by(&:seq)

unless supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end

# get the tag settings this questionnaire
tag_prompt_deployments = show_tags ? TagPromptDeployment.where(questionnaire_id: questionnaire.id, assignment_id: self.map.assignment.id) : nil
code = add_table_rows questionnaire_max, questions, answers, code, tag_prompt_deployments, current_user
end
comment = if !self.additional_comment.nil?
self.additional_comment.gsub('^p', '').gsub(/\n/, '<BR/>')
else
''
end
code += '<tr><td><b>Additional Comment: </b>' + comment + '</td></tr>'
code += '</table>'
end
</pre>

2. Views:

app/views/assignments/edit/_rubrics.html.erb

Add checkbox which professor used to indicate whether students can create their own questions.

<pre>

<input name="assignment_form[assignment][supplementary_review_questionnaire]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'true', @assignment_form.assignment.supplementary_review_questionnaire) %>
<%= label_tag('assignment_form[assignment][supplementary_review_questionnaire]', 'Allow student-generated questions added to rubric?') %>
</pre>

app/views/response/response.html.erb

Add code to show the supplementary questions to the reviewers.

<pre>
<br>
<% unless @supplementary_review_questions.nil? %>
<tr>
<td>
<h2>Supplementary Review Questions</h2>
</td>
</tr>
<% @supplementary_review_questions.each do |question| %>
<tr>
<td>
<% answer = Answer.where(question_id: question.id, response_id: @response.id).first if !@response.nil? %>
<% if question.instance_of? Criterion %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score, @dropdown_or_scale) %>
<%= tinymce %>
<% elsif question.instance_of? Scale %>
<%= question.complete(i, answer, @questionnaire.min_question_score, @questionnaire.max_question_score) %>
<%= tinymce %>
<% elsif question.instance_of? UploadFile %>
<% else %>
<%= question.complete(i, answer) %>
<% end %>
</td>
<td width="25%">
<% if [Criterion, TextArea].include? question.class %>
<div id="analysis_<%= i.to_s %>_comments"></div>
<% end %>
</td>
</tr>
<% i += 1 %>
<% end %>
<% end %>
</pre>

app/views/submitted_content/_main.html.erb

Add button for "your work" page to let students create their own questions.

<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.supplementary_review_questionnaire? %>
<%= button_to "Create Supplementary Rubric", {:controller => "questionnaires", :action => "create_supplementary_review_questionnaire", :id => participant.id } %>
<% else %>
The instructor hasn't enabled this feature for this assignment
<% end %>
<% end %>
</pre>

3. Controllers:

app/controllers/response_controller.rb

Add supplementary review questionnaires part to the create, edit, update methods and some other methods which getting the questionnaires.

<pre>
# Prepare the parameters when student clicks "Edit"
def edit
assign_instance_vars
get_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i && m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@supplementary_review_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end

@questionnaire = set_questionnaire
render action: 'response'
end

# Update the response and answers when student "edit" existing response
def update
render nothing: true unless action_allowed?
# the response to be updated
@response = Response.find(params[:id])
msg = ""
begin
@map = @response.map
@response.update_attribute('additional_comment', params[:review][:comments])

set_questionnaire
questions = sort_questions(@questionnaire.questions)
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
unless @supplementary_review_questionnaire.nil?
questions += supplementary_review_questions
end
create_answers(params, questions) unless params[:responses].nil?

@response.update_attribute('is_submitted', true) if params['isSubmit'] && params['isSubmit'] == 'Yes'
@response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
rescue StandardError
msg = "Your response was not saved. Cause:189 #{$ERROR_INFO}"
end
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Your response was submitted: #{@response.is_submitted}", request)
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, review: params[:review], save_options: params[:save_options]
end

def create
map_id = params[:id]
map_id = params[:map_id] unless params[:map_id].nil? # pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
@team_id = @map.reviewee_id

get_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')
was_submitted = false
@response = Response.where(map_id: @map.id, round: @round.to_i).first
if @response.nil?
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round.to_i,
is_submitted: is_submitted
)
end
was_submitted = @response.is_submitted
@response.update(additional_comment: params[:review][:comments], is_submitted: is_submitted) # ignore if autoupdate try to save when the response object is not yet created.

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
questions += supplementary_review_questions
end

create_answers(params, questions) if params[:responses]
msg = "Your response was successfully saved."
error_msg = ""
# only notify if is_submitted changes from false to true
if (@map.is_a? ReviewResponseMap) && (was_submitted == false && @response.is_submitted) && @response.significant_difference?
@response.notify_instructor_on_difference
@response.email
end
redirect_to controller: 'response', action: 'save', id: @map.map_id,
return: params[:return], msg: msg, error_msg: error_msg, review: params[:review], save_options: params[:save_options]
end

# new_response if a flag parameter indicating that if user is requesting a new rubric to fill
# if true: we figure out which questionnaire to use based on current time and records in assignment_questionnaires table
# e.g. student click "Begin" or "Update" to start filling out a rubric for others' work
# if false: we figure out which questionnaire to display base on @response object
# e.g. student click "Edit" or "View"
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)

unless @supplementary_review_questionnaire.nil?
@supplementary_review_questions = sort_questions(@supplementary_review_questionnaire.questions)
end

@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end

def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)

@supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@contributor.id)
unless @supplementary_review_questionnaire_id.nil?
@supplementary_review_questionnaire = Questionnaire.find(@supplementary_review_questionnaire_id)
end

when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)

supplementary_review_answer = @response.scores.last
@supplementary_review_questionnaire = @response.questionnaire_by_answer(supplementary_review_answer)

end

</pre>

app/controllers/grades_controller.rb

Add supplementary review responses to "Your Scores" section.

<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
counter_for_same_rubric = 0
questionnaires.each do |questionnaire|
@round = nil
if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
supplementary_review_questionnaire_id = Team.get_supplementary_review_questionnaire_id_of_team(@team_id)
unless supplementary_review_questionnaire_id.nil?
supplementary_review_questionnaire = Questionnaire.find(supplementary_review_questionnaire_id)
unless supplementary_review_questionnaire.nil?
supplementary_review_questions = supplementary_review_questionnaire.questions
questionnaire.questions += supplementary_review_questions
end
end
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>

app/controllers/questionnaires_controller.rb

Method for creating Supplementary Review Questionnaire.

<pre>
def create_supplementary_review_questionnaire
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.supplementary_review_questionnaire_id.nil?
@questionnaire = Questionnaire.create(privete: false, name: "supplementary_review_questionnaire_" + @team.id.to_s,
instructor_id: @team_id, min_question_score: 0, max_question_score: 5, type: "Questionnaire", display_type: "Review"
instruction_loc: Questionnaire::DEFAULT_QUESTIONNAIRE_URL)
if @questionnaire.save
@team.supplementary_review_questionnaire_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a rubric!'
else
flash[:error] = $ERROR_INFO
end
else
@questionnaire = Questionnaire.find(@team.supplementary_review_questionnaire_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end
</pre>

4. Config:

routes.rb
<pre>

resources :questionnaires, only: %i[new create edit update] do
collection do
get :copy
get :list
post :list_questionnaires
get :new_quiz
get :select_questionnaire_type
post :select_questionnaire_type
get :toggle_access
get :view
post :create_quiz_questionnaire
post :update_quiz
post :add_new_questions
post :save_all_questions
post :create_supplementary_review_questionnaire
end
end

resources :author_feedback_questionnaires, controller: :questionnaires
resources :review_questionnaires, controller: :questionnaires
resources :metareview_questionnaires, controller: :questionnaires
resources :teammate_review_questionnaires, controller: :questionnaires
resources :survey_questionnaires, controller: :questionnaires
resources :assignment_survey_questionnaires, controller: :questionnaires
resources :global_survey_questionnaires, controller: :questionnaires
resources :course_survey_questionnaires, controller: :questionnaires
resources :bookmarkrating_questionnaires, controller: :questionnaires
resources :supplementary_review_questionnaire, controller: :questionnaires
</pre>

'''Team members'''
----
Yanchen Zhao

Pingping Chen

Jianshu Zhang

Zirun Han

'''Links'''
----
Expertiza on Github:https://github.com/zyczyh/expertiza

Pull Request:https://github.com/expertiza/expertiza/pull/1325

Expertiza YouTube channel:https://youtu.be/3PUNknSbU-k

CSC/ECE 517 Fall 2019

2019-11-10T22:47:34Z

Hcao5:

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

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-11-05T21:53:04Z

Hcao5: /* Task */

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Team members ==
# Jing Cai (jcai3@ncsu.edu)
# Hua Cao (hcao5@ncsu.edu)
# Sichao Yu (syu25@ncsu.edu)
# Mentor: Harsh Agrawal (hagrawa2@ncsu.edu)

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. The score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for score and review report which also reduce the DRY problems.

=== Task Description ===

==== Background ====
* Currently Review report uses its own code to display reviews. This a pretty basic view, and it does not interpret HTML codes. It should be changed so that it calls the usual code that is used for displaying reviews, that gives the circle with the score inside.

==== Task ====
Currently, if you pull up a review report, and then click on one of the teams reviewed, e.g., the first one, you get a report that looks like this:
[[File:Team user popup before.png]]

We need to change the views to existing templates in view_my_scores pages.

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Updated View:

[[File:Team user popup after.png]]

Our changes can shown more apparently in the following video.<ref>https://youtu.be/Kd6iaHIT3Y8</ref>

== Implementation ==

=== Files modified in this project ===
*app/view/pop_up/team_users_popup.html.haml
*app/view/pop_up/team_users_popup.html.erb
*app/assets/stylesheets/grades.scss

=== Solution ===
The specific changes can be seemed in the comments of code.

Review report view is rendered in app/views/popup/team_users_popup.html.haml. First, we changed it to regular erb file. And fix some bugs between auto-change.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below. Just simply convert haml to erb.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
<% end %>
<tr>
<th>Reviewer Score (Σ weighted score/Σ weighted available score)</th>
<td align="center">
<%= instance_variable_get('@sum_round_' + round.to_s) %>
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
</td>
<td align="left">
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
</td>
</tr>
</table>
</pre>

Then we change the row and col layout and css style of this view.
The previous tables can be listed as below.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
/<%= instance_variable_get('@max_score_round_' + round.to_s) %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
</pre>
After we change the lay out, it can be listed as below.
<pre>
<table class="table table-striped grades">
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<th colspan="2">
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
</th>
</tr>

<tr>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<%= answer.answer %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="left" width="5%>
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% end %>
<td align="left" width="95%">
<%= answer.comments %>
</td>
</tr>
<% end %>
</pre>

We also fixed some small bug about the checkbox questions and index of the questions.
We fixed the if-else logic question, in order that checkbox questions can be showed properly.
<pre>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% elsif answer.question.is_a?(Checkbox) %>
<%= answer.question.seq.to_i %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% end %>
</pre>
We also changed the outlook of score and make it to be a circle.
<pre>
<td align="left" width="5%">
<div class="c<%= answer.answer %> grade-circle"><%= answer.answer %></div>
</td>
</pre>
And the css is in grades.scss
<pre>
/* This is a grade circle for different grades. */
.grade-circle {
width:30px;
height:30px;
border-radius:50%;
font-size:15px;
color:black;
line-height:30px;
text-align:center;
}
</pre>

We added the "index" in this view, in order to show the proper sequence of review's question.
<pre>
<% index = 1 %>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr class="warning">
<th colspan="2">
<%= index%>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= '. ' %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% index = index +1 %>
<% elsif answer.question.is_a?(Checkbox) %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% index = index + 1 %>
<% end %>
</pre>

At last, we add the css style "warning" and "info" for the table and review score. So that it looks more beautiful.
<pre>
<tr class="warning">
<th colspan="2">
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
</th>
</tr>

<tr class="info">
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>

</pre>

==Test Plan==
Our test plan are mostly manual. There are two reasons why we choose UI testing:
# As we only change the layout of several views. We can only test them from UI testing.
# The existing templates view_my_score are also tested with UI, without any Rspec testing.

There are two test cases for UI testing.
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment

== References ==
<references/>

== Other Links ==
#[https://github.com/ljxxcaijing/expertiza/tree/beta GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1532 GitHub Pull Request]
#[https://youtu.be/Kd6iaHIT3Y8 Youtube Video Demo]

File:Team user popup after.png

2019-11-05T21:52:44Z

Hcao5:

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-11-05T21:52:17Z

Hcao5: /* Task */

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Team members ==
# Jing Cai (jcai3@ncsu.edu)
# Hua Cao (hcao5@ncsu.edu)
# Sichao Yu (syu25@ncsu.edu)
# Mentor: Harsh Agrawal (hagrawa2@ncsu.edu)

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. The score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for score and review report which also reduce the DRY problems.

=== Task Description ===

==== Background ====
* Currently Review report uses its own code to display reviews. This a pretty basic view, and it does not interpret HTML codes. It should be changed so that it calls the usual code that is used for displaying reviews, that gives the circle with the score inside.

==== Task ====
Currently, if you pull up a review report, and then click on one of the teams reviewed, e.g., the first one, you get a report that looks like this:
[[File:Team user popup before.png]]

We need to change the views to existing templates in view_my_scores pages.

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Updated View:

[[File:Team user popup after.jpg]]

Our changes can shown more apparently in the following video.<ref>https://youtu.be/Kd6iaHIT3Y8</ref>

== Implementation ==

=== Files modified in this project ===
*app/view/pop_up/team_users_popup.html.haml
*app/view/pop_up/team_users_popup.html.erb
*app/assets/stylesheets/grades.scss

=== Solution ===
The specific changes can be seemed in the comments of code.

Review report view is rendered in app/views/popup/team_users_popup.html.haml. First, we changed it to regular erb file. And fix some bugs between auto-change.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below. Just simply convert haml to erb.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
<% end %>
<tr>
<th>Reviewer Score (Σ weighted score/Σ weighted available score)</th>
<td align="center">
<%= instance_variable_get('@sum_round_' + round.to_s) %>
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
</td>
<td align="left">
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
</td>
</tr>
</table>
</pre>

Then we change the row and col layout and css style of this view.
The previous tables can be listed as below.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
/<%= instance_variable_get('@max_score_round_' + round.to_s) %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
</pre>
After we change the lay out, it can be listed as below.
<pre>
<table class="table table-striped grades">
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<th colspan="2">
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
</th>
</tr>

<tr>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<%= answer.answer %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="left" width="5%>
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% end %>
<td align="left" width="95%">
<%= answer.comments %>
</td>
</tr>
<% end %>
</pre>

We also fixed some small bug about the checkbox questions and index of the questions.
We fixed the if-else logic question, in order that checkbox questions can be showed properly.
<pre>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% elsif answer.question.is_a?(Checkbox) %>
<%= answer.question.seq.to_i %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% end %>
</pre>
We also changed the outlook of score and make it to be a circle.
<pre>
<td align="left" width="5%">
<div class="c<%= answer.answer %> grade-circle"><%= answer.answer %></div>
</td>
</pre>
And the css is in grades.scss
<pre>
/* This is a grade circle for different grades. */
.grade-circle {
width:30px;
height:30px;
border-radius:50%;
font-size:15px;
color:black;
line-height:30px;
text-align:center;
}
</pre>

We added the "index" in this view, in order to show the proper sequence of review's question.
<pre>
<% index = 1 %>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr class="warning">
<th colspan="2">
<%= index%>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= '. ' %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% index = index +1 %>
<% elsif answer.question.is_a?(Checkbox) %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% index = index + 1 %>
<% end %>
</pre>

At last, we add the css style "warning" and "info" for the table and review score. So that it looks more beautiful.
<pre>
<tr class="warning">
<th colspan="2">
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
</th>
</tr>

<tr class="info">
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>

</pre>

==Test Plan==
Our test plan are mostly manual. There are two reasons why we choose UI testing:
# As we only change the layout of several views. We can only test them from UI testing.
# The existing templates view_my_score are also tested with UI, without any Rspec testing.

There are two test cases for UI testing.
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment

== References ==
<references/>

== Other Links ==
#[https://github.com/ljxxcaijing/expertiza/tree/beta GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1532 GitHub Pull Request]
#[https://youtu.be/Kd6iaHIT3Y8 Youtube Video Demo]

File:Team user popup before.png

2019-11-05T21:51:38Z

Hcao5:

File:Team user popup before.jpeg

2019-11-05T21:50:10Z

Hcao5: uploaded a new version of "File:Team user popup before.jpeg"

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-10-26T01:04:29Z

Hcao5: /* Solution */

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. Both score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for both score and review report which also reduce the DRY problems. There is no functionality for user to search between reviews of particular project, such a functionality will help user to search through all reviews for specific problem they are trying to focus on.

=== Task Description ===

==== Background ====
* Currently Review report uses its own code to display reviews. This a pretty basic view, and it does not interpret HTML codes. It should be changed so that it calls the usual code that is used for displaying reviews, that gives the circle with the score inside.

==== Task ====
Currently, if you pull up a review report, and then click on one of the teams reviewed, e.g., the first one, you get a report that looks like this:
[[File:Team user popup before.jpeg]]

We need to change the views to existing templates in view_my_scores pages.

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Updated View:

[[File:Team user popup after.jpg]]

== Implementation ==

=== Files modified in this project ===
*team_users_popup.html.haml
*team_users_popup.html.erb

=== Solution ===

Review report view is rendered in app/views/popup/team_users_popup.html.haml. First, we changed it to regular erb file. And fix some bugs between auto-change.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below. Just simply convert haml to erb.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
<% end %>
<tr>
<th>Reviewer Score (Σ weighted score/Σ weighted available score)</th>
<td align="center">
<%= instance_variable_get('@sum_round_' + round.to_s) %>
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
</td>
<td align="left">
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
</td>
</tr>
</table>
</pre>

Then we change the row and col layout and css style of this view.
The previous tables can be listed as below.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
/<%= instance_variable_get('@max_score_round_' + round.to_s) %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
</pre>
After we change the lay out, it can be listed as below.
<pre>
<table class="table table-striped grades">
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<th colspan="2">
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
</th>
</tr>

<tr>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<%= answer.answer %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="left" width="5%>
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% end %>
<td align="left" width="95%">
<%= answer.comments %>
</td>
</tr>
<% end %>
</pre>

We also fixed some small bug about the checkbox questions and index of the questions.
We fixed the if-else logic question, in order that checkbox questions can be showed properly.
<pre>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% elsif answer.question.is_a?(Checkbox) %>
<%= answer.question.seq.to_i %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% end %>
</pre>
We also changed the outlook of score and make it to be a circle.
<pre>
<td align="left" width="5%">
<div class="c<%= answer.answer %> grade-circle"><%= answer.answer %></div>
</td>
</pre>
And the css is in grades.scss
<pre>
/* This is a grade circle for different grades. */
.grade-circle {
width:30px;
height:30px;
border-radius:50%;
font-size:15px;
color:black;
line-height:30px;
text-align:center;
}
</pre>

We added the "index" in this view, in order to show the proper sequence of review's question.
<pre>
<% index = 1 %>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr class="warning">
<th colspan="2">
<%= index%>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= '. ' %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% index = index +1 %>
<% elsif answer.question.is_a?(Checkbox) %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% index = index + 1 %>
<% end %>
</pre>

At last, we add the css style "warning" and "info" for the table and review score. So that it looks more beautiful.
<pre>
<tr class="warning">
<th colspan="2">
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
</th>
</tr>

<tr class="info">
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>

</pre>

==UI Testing==
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment

== References ==
<references/>

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-10-26T00:33:40Z

Hcao5: /* Future Improvements */

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. Both score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for both score and review report which also reduce the DRY problems. There is no functionality for user to search between reviews of particular project, such a functionality will help user to search through all reviews for specific problem they are trying to focus on.

=== Task Description ===

==== Background ====
* Currently Review report uses its own code to display reviews. This a pretty basic view, and it does not interpret HTML codes. It should be changed so that it calls the usual code that is used for displaying reviews, that gives the circle with the score inside.

==== Task ====
Currently, if you pull up a review report, and then click on one of the teams reviewed, e.g., the first one, you get a report that looks like this:
[[File:Team user popup before.jpeg]]

We need to change the views to existing templates in view_my_scores pages.

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Updated View:

[[File:Team user popup after.jpg]]

== Implementation ==

=== Files modified in this project ===
*team_users_popup.html.haml
*team_users_popup.html.erb

=== Solution ===

Review report view is rendered in app/views/popup/team_users_popup.html.haml. First, we changed it to regular erb file. And fix some bugs between auto-change.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below. Just simply convert haml to erb.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
<% end %>
<tr>
<th>Reviewer Score (Σ weighted score/Σ weighted available score)</th>
<td align="center">
<%= instance_variable_get('@sum_round_' + round.to_s) %>
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
</td>
<td align="left">
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
</td>
</tr>
</table>
</pre>

Then we change the row and col layout and css style of this view.
The previous tables can be listed as below.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
/<%= instance_variable_get('@max_score_round_' + round.to_s) %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
</pre>
After we change the lay out, it can be listed as below.
<pre>
<table class="table table-striped grades">
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<th colspan="2">
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
</th>
</tr>

<tr>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<%= answer.answer %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="left" width="5%>
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% end %>
<td align="left" width="95%">
<%= answer.comments %>
</td>
</tr>
<% end %>
</pre>

We also fixed some small bug about the checkbox questions and index of the questions.
We fixed the if-else logic question, in order that checkbox questions can be showed properly.
<pre>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% elsif answer.question.is_a?(Checkbox) %>
<%= answer.question.seq.to_i %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% end %>
</pre>
We also changed the outlook of score and make it to be a circle.
<pre>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>
</td>
</pre>

We added the "index" in this view, in order to show the proper sequence of review's question.
<pre>
<% index = 1 %>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr class="warning">
<th colspan="2">
<%= index%>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= '. ' %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% index = index +1 %>
<% elsif answer.question.is_a?(Checkbox) %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% index = index + 1 %>
<% end %>
</pre>

At last, we add the css style "warning" and "info" for the table and review score. So that it looks more beautiful.
<pre>
<tr class="warning">
<th colspan="2">
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
</th>
</tr>

<tr class="info">
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>

</pre>

==UI Testing==
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment

== References ==
<references/>

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-10-26T00:32:32Z

Hcao5: /* Task */

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. Both score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for both score and review report which also reduce the DRY problems. There is no functionality for user to search between reviews of particular project, such a functionality will help user to search through all reviews for specific problem they are trying to focus on.

=== Task Description ===

==== Background ====
* Currently Review report uses its own code to display reviews. This a pretty basic view, and it does not interpret HTML codes. It should be changed so that it calls the usual code that is used for displaying reviews, that gives the circle with the score inside.

==== Task ====
Currently, if you pull up a review report, and then click on one of the teams reviewed, e.g., the first one, you get a report that looks like this:
[[File:Team user popup before.jpeg]]

We need to change the views to existing templates in view_my_scores pages.

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Updated View:

[[File:Team user popup after.jpg]]

== Implementation ==

=== Files modified in this project ===
*team_users_popup.html.haml
*team_users_popup.html.erb

=== Solution ===

Review report view is rendered in app/views/popup/team_users_popup.html.haml. First, we changed it to regular erb file. And fix some bugs between auto-change.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below. Just simply convert haml to erb.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
<% end %>
<tr>
<th>Reviewer Score (Σ weighted score/Σ weighted available score)</th>
<td align="center">
<%= instance_variable_get('@sum_round_' + round.to_s) %>
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
</td>
<td align="left">
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
</td>
</tr>
</table>
</pre>

Then we change the row and col layout and css style of this view.
The previous tables can be listed as below.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
/<%= instance_variable_get('@max_score_round_' + round.to_s) %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
</pre>
After we change the lay out, it can be listed as below.
<pre>
<table class="table table-striped grades">
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<th colspan="2">
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
</th>
</tr>

<tr>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<%= answer.answer %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="left" width="5%>
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% end %>
<td align="left" width="95%">
<%= answer.comments %>
</td>
</tr>
<% end %>
</pre>

We also fixed some small bug about the checkbox questions and index of the questions.
We fixed the if-else logic question, in order that checkbox questions can be showed properly.
<pre>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% elsif answer.question.is_a?(Checkbox) %>
<%= answer.question.seq.to_i %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% end %>
</pre>
We also changed the outlook of score and make it to be a circle.
<pre>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>
</td>
</pre>

We added the "index" in this view, in order to show the proper sequence of review's question.
<pre>
<% index = 1 %>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr class="warning">
<th colspan="2">
<%= index%>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= '. ' %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% index = index +1 %>
<% elsif answer.question.is_a?(Checkbox) %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% index = index + 1 %>
<% end %>
</pre>

At last, we add the css style "warning" and "info" for the table and review score. So that it looks more beautiful.
<pre>
<tr class="warning">
<th colspan="2">
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
</th>
</tr>

<tr class="info">
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>

</pre>

==UI Testing==
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment

== Future Improvements ==

== References ==
<references/>

File:Team user popup before.jpeg

2019-10-26T00:27:32Z

Hcao5:

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-10-26T00:27:02Z

Hcao5: /* Task */

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. Both score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for both score and review report which also reduce the DRY problems. There is no functionality for user to search between reviews of particular project, such a functionality will help user to search through all reviews for specific problem they are trying to focus on.

=== Task Description ===

==== Background ====
* Currently Review report uses its own code to display reviews. This a pretty basic view, and it does not interpret HTML codes. It should be changed so that it calls the usual code that is used for displaying reviews, that gives the circle with the score inside.

==== Task ====
Currently, if you pull up a review report, and then click on one of the teams reviewed, e.g., the first one, you get a report that looks like this:
[[File:review_report.png]]

We need to change the views to existing templates in view_my_scores pages.

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Updated View:

[[File:Team user popup after.jpg]]

== Implementation ==

=== Files modified in this project ===
*team_users_popup.html.haml
*team_users_popup.html.erb

=== Solution ===

Review report view is rendered in app/views/popup/team_users_popup.html.haml. First, we changed it to regular erb file. And fix some bugs between auto-change.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below. Just simply convert haml to erb.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
<% end %>
<tr>
<th>Reviewer Score (Σ weighted score/Σ weighted available score)</th>
<td align="center">
<%= instance_variable_get('@sum_round_' + round.to_s) %>
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
</td>
<td align="left">
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
</td>
</tr>
</table>
</pre>

Then we change the row and col layout and css style of this view.
The previous tables can be listed as below.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
/<%= instance_variable_get('@max_score_round_' + round.to_s) %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
</pre>
After we change the lay out, it can be listed as below.
<pre>
<table class="table table-striped grades">
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<th colspan="2">
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
</th>
</tr>

<tr>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<%= answer.answer %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="left" width="5%>
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% end %>
<td align="left" width="95%">
<%= answer.comments %>
</td>
</tr>
<% end %>
</pre>

We also fixed some small bug about the checkbox questions and index of the questions.
We fixed the if-else logic question, in order that checkbox questions can be showed properly.
<pre>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% elsif answer.question.is_a?(Checkbox) %>
<%= answer.question.seq.to_i %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% end %>
</pre>
We also changed the outlook of score and make it to be a circle.
<pre>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>
</td>
</pre>

We added the "index" in this view, in order to show the proper sequence of review's question.
<pre>
<% index = 1 %>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr class="warning">
<th colspan="2">
<%= index%>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= '. ' %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% index = index +1 %>
<% elsif answer.question.is_a?(Checkbox) %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% index = index + 1 %>
<% end %>
</pre>

At last, we add the css style "warning" and "info" for the table and review score. So that it looks more beautiful.
<pre>
<tr class="warning">
<th colspan="2">
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
</th>
</tr>

<tr class="info">
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>

</pre>

==UI Testing==
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment

== Future Improvements ==

== References ==
<references/>

File:Team user popup after.jpg

2019-10-26T00:25:41Z

Hcao5:

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-10-26T00:18:52Z

Hcao5:

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. Both score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for both score and review report which also reduce the DRY problems. There is no functionality for user to search between reviews of particular project, such a functionality will help user to search through all reviews for specific problem they are trying to focus on.

=== Task Description ===

==== Background ====
* Currently Review report uses its own code to display reviews. This a pretty basic view, and it does not interpret HTML codes. It should be changed so that it calls the usual code that is used for displaying reviews, that gives the circle with the score inside.

==== Task ====
Currently, if you pull up a review report, and then click on one of the teams reviewed, e.g., the first one, you get a report that looks like this:
[[File:review_report.png]]

We need to change the views to existing templates in view_my_scores pages.

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Updated View:

[[File:Modified review2.png]]

== Implementation ==

=== Files modified in this project ===
*team_users_popup.html.haml
*team_users_popup.html.erb

=== Solution ===

Review report view is rendered in app/views/popup/team_users_popup.html.haml. First, we changed it to regular erb file. And fix some bugs between auto-change.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below. Just simply convert haml to erb.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
<% end %>
<tr>
<th>Reviewer Score (Σ weighted score/Σ weighted available score)</th>
<td align="center">
<%= instance_variable_get('@sum_round_' + round.to_s) %>
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
</td>
<td align="left">
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
</td>
</tr>
</table>
</pre>

Then we change the row and col layout and css style of this view.
The previous tables can be listed as below.
<pre>
<table border="1px solid #ccc" class="general">
<tr>
<th align="left" width="50%">Question</th>
<th width="5%">Score</th>
<th width="45%">Comments</th>
</tr>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<td align="left">
<%= answer.question.txt %>
</td>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="center">
<%= answer.answer %>
/<%= instance_variable_get('@max_score_round_' + round.to_s) %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="center">
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% else %>
<td align="center">
<%= answer.answer %>
</td>
<% end %>
<td align="left">
<%= answer.comments %>
</td>
</tr>
</pre>
After we change the lay out, it can be listed as below.
<pre>
<table class="table table-striped grades">
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr>
<th colspan="2">
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
</th>
</tr>

<tr>
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<%= answer.answer %>
</td>
<% elsif answer.question.is_a?(Checkbox) %>
<td align="left" width="5%>
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
</td>
<% end %>
<td align="left" width="95%">
<%= answer.comments %>
</td>
</tr>
<% end %>
</pre>

We also fixed some small bug about the checkbox questions and index of the questions.
We fixed the if-else logic question, in order that checkbox questions can be showed properly.
<pre>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% elsif answer.question.is_a?(Checkbox) %>
<%= answer.question.seq.to_i %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% end %>
</pre>
We also changed the outlook of score and make it to be a circle.
<pre>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>
</td>
</pre>

We added the "index" in this view, in order to show the proper sequence of review's question.
<pre>
<% index = 1 %>
<% instance_variable_get('@scores_round_' + round.to_s).each do |answer| %>
<tr class="warning">
<th colspan="2">
<%= index%>
<% if answer.question.is_a?(ScoredQuestion) %>
<%= '. ' %>
<%= '. ' %>
<%= answer.question.txt %>
<%= '[Max points: '%>
<%= instance_variable_get('@max_score_round_' + round.to_s) %>
<%= ']'%>
<% index = index +1 %>
<% elsif answer.question.is_a?(Checkbox) %>
<%= '.' %> 
<%= answer.answer==0 ? image_tag("delete_icon.png"): image_tag("Check-icon.png") %>
<%= answer.question.txt %>
<% index = index + 1 %>
<% end %>
</pre>

At last, we add the css style "warning" and "info" for the table and review score. So that it looks more beautiful.
<pre>
<tr class="warning">
<th colspan="2">
<% if answer.question.is_a?(ScoredQuestion) %>
<%= answer.question.seq.to_i %>
</th>
</tr>

<tr class="info">
<% if answer.question.is_a?(ScoredQuestion) %>
<td align="left" width="5%">
<div class="c<%= answer.answer %>" style="width:30px; height:30px; border-radius:50%; font-size:15px; color:black; line-height:30px; text-align:center;"><%= answer.answer %></div>

</pre>

==UI Testing==
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment

== Future Improvements ==

== References ==
<references/>

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-10-26T00:16:45Z

Hcao5:

CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews

2019-10-21T19:52:35Z

Hcao5: Created page with "== Introduction == Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incr..."

== Introduction ==

Expertiza<ref>https://expertiza.ncsu.edu/</ref> is an open-source web application to create re-usable learning objects through peer-reviews to facilitate incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails<ref>https://en.wikipedia.org/wiki/Ruby_on_Rails</ref> framework and is supported by the [http://www.nsf.gov National Science Foundation].

== Project Description ==

=== Purpose and Scope ===

Expertiza assignments are based on a peer review system where the instructor creates rubrics for an assignment through questionnaires which students use to review other students' submissions. The author of the submission is given an opportunity to provide feedback about these reviews. Expertiza displays reviews (i) to the team who was reviewed, and (ii) to the reviewer. A student user can see all the reviews of his/her team’s project. The instructor can see all the reviews of everyone’s project. The instructor also has access to a Review report, which shows, for each reviewer, all the reviews that (s)he wrote. Both score report and review report use different code so UI is non-orthogonal, it would be great if we can follow same UI structure for both score and review report which also reduce the DRY problems. There is no functionality for user to search between reviews of particular project, such a functionality will help user to search through all reviews for specific problem they are trying to focus on.

=== Task Description ===

The project requires completion of the following tasks:
====Task-1 (Update review report view in Instructor's view)====
* A single way of displaying reviews that would be visible to students (reviews that they did, and reviews that their team received), and instructors (reviews that each team received, sorted by team; and reviews that each student did, sorted by student)

For student view the UI is consistent in displaying reviews they have done and reviews they have received but for instructor's view the review report follows different UI and have different code. To make the UI consistent we have decided to choose the UI design of student view as the base and modify the UI design for review report in instructor's view. This will allow us to use the same code in both views, thereby following DRY principle.

Previous View:

[[File:review_report.png]]

Updated View:

[[File:review-report-changed.png]]

Implementation:

Review report view is rendered in app/views/popup/team_users_popup.html.haml. In this view, we populate table by iterating over each question under each round. While same approach was used previously but here we replace each row by a predefined format used for rendering question similar to student view.

<pre>
%table{:border => "1px solid #ccc"}
%tr
%th{:align => "left", :width => "50%"} Question
%th{:width => "5%"} Score
%th{:width => "45%"} Comments
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
%tr
%td{:align => "left"}
= Question.find(s.question_id).txt
- if Question.find(s.question_id).is_a?(ScoredQuestion)
%td{:align => "center"}
= s.answer
\/#{instance_variable_get('@max_score_round_' + round.to_s)}
- else
%td{:align => "center"}
= s.answer
%td{:align => "left"}
= s.comments
%tr
%th Reviewer Score (Σ weighted score/Σ weighted available score)
%td{:align => "center"}
= instance_variable_get('@sum_round_' + round.to_s)
\/#{instance_variable_get('@total_possible_round_' + round.to_s)}
%td{:align => "left"}
\= #{instance_variable_get('@total_percentage_round_' + round.to_s)}
%table
</pre>

We replace the above code by code below, here in each row we invoke view_completed_question method defined in Criterion.rb for scored questions which insert the html code to render question,score,comments.

<pre>
%table{:border => "1px solid #ccc" ,:class => "table table-bordered"}
- counter = 0
- instance_variable_get('@scores_round_' + round.to_s).each do |s|
- counter += 1
- row_class = counter.even? ? "info" : "warning"
- question = Question.find(s.question_id)
%tr{:class => row_class}
%td
= question.becomes(Criterion).view_completed_question(counter,s,instance_variable_get('@max_score_round_' + round.to_s))
%tr
%td{:style => "font-weight:bold"}
= 'Reviewer Score (Σ weighted score/Σ weighted available score) = '+ instance_variable_get('@sum_round_' + round.to_s).to_s |
\/ #{instance_variable_get('@total_possible_round_' + round.to_s)} (#{instance_variable_get('@total_percentage_round_' + round.to_s)}%)
%table
</pre>

====Task-2 (Button to show/hide all the reviews)====
* Add button/link to hide and expand all the reviews for a Round.

In student view,for a particular assignment, the UI has <code>show review</code> button for each review in a round. Adding a single button will help student view all the review of a round with single click.

Previous View:

[[File:P11.jpg]]

<br>Updated View:

[[File:Update2.png]]

<br>Implementation:
<br>
<p>Review view is rendered in app/views/grades/_reviews.html.erb. In this view, we added <code>show all reviews</code> and <code>hide all reviews</code> buttons which when clicked call <code>toggleAllElement</code> function and displays all the reviews of a round.</p>
<pre>

<a href="#" name=<%="roundshow_" + round.to_s + "Link" %> onClick="toggleAllElement('<%= str %>','show');return false;">show all reviews</a>
<a href="#" name=<%="roundhide_" + round.to_s + "Link" %> onClick="toggleAllElement('<%= str %>','hide');return false;">hide all reviews</a>

</pre>
<p> We added <code>toggleAllElemnet</code> function in app/assets/javascripts/tableactions.js which toggles all the review of a round using existing <code>toggleElement</code> function.</p>
<pre>
function toggleAllElement(elementIdList, mode=''){
console.log(elementIdList)
var res = elementIdList.split(",");
var childText = 'review';

for (var y = 0; y < res.length - 1; y++) {
toggleElement(res[y], childText, mode);
}
}
</pre>

====Task-3(Create a tabbed view for stats, reviews and heatmap)====
* Create a tabbed view for each review view type : Statistic, Reviews and Alternate Views tabs.

Initially I weighed using TabsOnRails or Tabulous gems to create the tabs for this project but after doing some research these gems did not allow me to create tabs dynamically so Jquery UI was used to create the tabs. This was a plus since we did not need to install a new gem to the project. The review report will need to be modified to have the addition of the Statistic, Reviews and Alternate Views tabs at the top of the page. It will default to the Statistics tab which should look something like:

[[File:tabStats.png]]

And the Reviews tab should produce a view like:

[[File:tabReviews.png]]

The Alternate View tab should produce a view like:

[[File:tabAlt.png]]

=====Task 3 Implementation=====

To create the tabs on the view_my_scores view we used the following Jquery code:

<pre>
<div id="tabs">
<ul>
<li><a href="#tabs-1">Stats</a></li>
<li><a href="#tabs-2">Reviews</a></li>
<li><a href="#tabs-3">Alternate View</a></li>
</ul>
<div id="tabs-1">
<TABLE class="grades" >
<%= render :partial => 'grades/participant_charts', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant_title', :locals => {:prefix => nil} %>
<%= render :partial => 'grades/participant', :locals => {:prefix => 'user',
:team => false,
:participant_id => ptid = @participant.id,
:index => 0,
:team_size => 1,
:pscore => @pscore} %>

</TABLE>
<% case @assignment.reputation_algorithm %>
<% when 'Hamer' %>
<h3>Reputation</h3>
<p id = "reputation_score" class = <%= get_css_style_for_hamer_reputation(@participant.Hamer)%> style = "width:60px;"><%= @participant.Hamer %></p>
<% when 'Lauw' %>
<h3>Reputation</h3>
<p id = "reputation_score" class = <%= get_css_style_for_lauw_reputation(@participant.Lauw)%> style = "width:60px;"><%= @participant.Lauw %></p>
<%end%>
</div>
<div id="tabs-2">
<TABLE>
<TR>
<TD COLSPAN="10"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => @pscore[:participant], :rscore => @pscore[:review]} %></TD>
</TR>
</TABLE>
</div>
<div id="tabs-3">
<%= render "view_team", :id => params[:id] %>
</div>
</div>

<script>
$(function() {
$( "#tabs" ).tabs();
});
</script>
</pre>

The Stats tab was easy since we just took what was already in that view and moved it to only be displayed under the first tab.

The Review tab was created by pulling up the rendering of the review partial out of the participant partial. This just needed to point the local variables to variables that were in this View.

The Alternate View tab was a bit tricky since it was it's on view (view_team). So what was done was creating a partial named _view_team and moving all of the code that was in that view the partial and rendering the partial in the view_team view. This allowed us to access this view from the view_team and view_my_score views simultaneously while using the same code base.

We were going to add the sub tabs for the Reviewers but after implementing the "show all reviews" buttons those tabs became tricky and the page got really cluttered. So we decided that we could just keep the existing scores Review layout with the changes of toggling whether to hide or show the reviews.

=====Task 3 Testing=====

To test this feature go to the view_my_scores page for the student where you should see the 3 tabs.
Make sure that each tab gives you a similar view as described above.

====Task-4(Buttons to toggle questions/score/answers)====
* Make review feedback more readable by changing UI or background color.
* Option to toggle review question or score or answers.

This task is to make feedback response more readable or more focused for user to read. Instructor suggested this can be done by graying out the question or we can change the background of the response text. The existing review also has this behavior. We added toggle button to show/hide questions/score/answers for a review based on instructor suggestion.

Previous View:<br>
[[File: Taskk44.jpg]]

<br>Update View:<br>
[[File: Updated4.png]]

<br>Implementation:
<p> The implementation of this functionality is similar to Task 2. A review is rendered in app/models/response.rb. We added <code>toggle questions,</code>
<code>toggle score and</code> <code>toggle answers</code> button in a review view, which when clicked calls <code>toggleAllElement</code> function in app/assets/javascripts/tableactions.js that toggles respective view.
</p>
<pre>
code+='<br><a href="#" name= "question_' + str + 'Link" onClick="toggleAllElement(' + "'" + str_ques + "','review'" + ');return false;">toggle questions</a>'
code+='   <a href="#" name= "score_' + str + 'Link" onClick="toggleAllElement(' + "'" + str_score + "','review'" + ');return false;">toggle scores</a>'
code+='   <a href="#" name= "answer_' + str + 'Link" onClick="toggleAllElement(' + "'" + str_answer + "','review'" + ');return false;">toggle answers</a>'
</pre>

====Task-5 (Change view in response controller, when clicked on review link)====
When scores are view in alternate view(Heat map) it displays score received for each review in tabular format when we click on any review hyperlink it invokes view method of response controller which render unnecessary elements like submission content, upload file button,etc along with review and feedback, instead it should just show review and feedback. So we created a new view to implement this functionality and removed other unrequired elements.

Files updated:

app/controllers/response_controller.rb
app/views/grades/_view_team.html.erb
app/views/response/view_review.html.erb
config/routes.rb

We have selected the unrequired element in below mockup image.

[[File:Review_view.png]]

=====UI TEST=====
* Log-in as student.
* Go to particular assignment
* Select alternative view
* Click on any review hyperlink, to see reviews.

====Task-6 (Optional if Task 2 is complete)====
* Add search box to search between reviews for particular string for a specific project(Student's view) or for specific user(Instructor's view).
This functionality will help user to readily access the required content within the reviews.<br />
Below is the mock-up image of how functionality will look after implementations

[[File:SearchFunctionality.png]]

==UI Testing==
* To Test UI for student View
** Log-in as Student.
** Go to Assignment
** Click Your scores
** Click show reviews

* To Test UI for instructor View
** Log-in as Instructor.
** Go to Manage Assignments
** Click on review report of a particular assignment
** Click on any item in team reviewed tab, to see reviews.

== Future Improvements ==

== References ==
<references/>