Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-07T01:36:40Z

Pharida:

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login as an instructor and change the due dates for the assignments to be tested. Here the assignment chosen is Final project (and design doc).
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>

<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc). Here click on the assih=gment for which the due dates were changed.</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

[[File:Iconpage.png|center]]

=== Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-07T01:34:58Z

Pharida: /* Part 2: Allow students to identify that their submission has been reviewed by the instructor */

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-07T01:33:56Z

Pharida:

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login as an instructor and change the due dates for the assignments to be tested. Here the assignment chosen is Final project (and design doc).
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>

<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc)</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

[[File:Iconpage.png|center]]

=== Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

File:Iconpage.png

2019-12-07T01:30:33Z

Pharida: uploaded a new version of "File:Iconpage.png"

File:Iconpage.png

2019-12-07T01:29:32Z

Pharida: uploaded a new version of "File:Iconpage.png"

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-07T01:23:33Z

Pharida: /* Part 2: Allow students to identify that their submission has been reviewed by the instructor */

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc)</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

[[File:Iconpage.png|center]]

===Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

File:Iconpage.png

2019-12-07T01:23:02Z

Pharida:

File:Page.png

2019-12-07T01:19:46Z

Pharida: uploaded a new version of "File:Page.png"

File:Page.png

2019-12-07T01:18:59Z

Pharida: uploaded a new version of "File:Page.png": Reverted to version as of 23:21, 6 December 2019

File:Page.png

2019-12-07T01:18:52Z

Pharida: uploaded a new version of "File:Page.png": Reverted to version as of 01:17, 7 December 2019

File:Page.png

2019-12-07T01:18:45Z

Pharida: uploaded a new version of "File:Page.png": Reverted to version as of 01:15, 7 December 2019

File:Page.png

2019-12-07T01:17:08Z

Pharida: uploaded a new version of "File:Page.png"

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-07T01:15:58Z

Pharida:

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc)</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

[[File:page.jpg|center]]

===Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

File:Page.png

2019-12-07T01:15:29Z

Pharida: uploaded a new version of "File:Page.png"

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-07T01:02:22Z

Pharida:

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc)</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

[[File:page.png|center]]

===Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

File:Page.png

2019-12-06T23:33:11Z

Pharida: uploaded a new version of "File:Page.png"

File:Page.jpg

2019-12-06T23:28:06Z

Pharida: uploaded a new version of "File:Page.jpg"

File:Page.jpg

2019-12-06T23:27:28Z

Pharida: uploaded a new version of "File:Page.jpg"

File:Page.jpg

2019-12-06T23:25:25Z

Pharida:

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-06T23:23:30Z

Pharida:

[[File:[[File:Example.jpg]]]]== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc)</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

[[File:page.png|center]]

===Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

File:Page.png

2019-12-06T23:21:32Z

Pharida:

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-06T23:18:43Z

Pharida:

[[File:[[File:Example.jpg]]]]== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc)</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

[File:instructor_icon_48.jpg|center]]

===Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

File:Instructor icon 48.jpg

2019-12-06T23:15:43Z

Pharida:

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-12-06T23:14:49Z

Pharida:

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However, sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience. Currently, there exists no method for the instructor/TA to perform reviews of assignments submitted by the students. Hence this is what this project aims at, allowing instructor/TA to perform reviews.

Thus, the primary aim of this project is to allow instructors to submit reviews of student work, using the same review form that students use to do reviews.

=='''Implementation Details''' ==
Our project aims at enabling the instructor/TA to review the submissions using the same form that a student uses while peer-reviewing. For this, our implementation has been divided into 3 parts, and can be described as follows:
<ol>
<li>The first part involves the primary functionality of letting the staff perform a review on students submission.</li>
<li>The second part involves allowing the students to identify from their end, which review has been performed by an instructor/TA. This will help students improve their project as the opinions presented by a staff member would be valid.</li>
<li>Thirdly, we implemented an additional feature that allows the instructor/TA to add himself as a participant while creating/editing an Assignment (This way seemed to be more convenient rather than going to the “Add Participant” page and adding themselves as a participant.)</li>
</ol>

===Part 1: Allowing instructor/TA to perform review===
Note 1: “Instructor/TA” will be referred to by “user” here onwards.

Note 2: To be able to perform a review, the user has to be a participant of that assignment. We have implemented “Add as Participant” as an additional feature which is explained in Part 3. If the user is not a participant, he will only see the link to “Assign grade” that too after the assignment deadline passes.
Now, for each assignment, there is a page called “List Submissions” where the user can view all the submissions. So we have modified this page so that for each team submission a link for “Begin review,” “Edit review,” “View review,” “Update review,” or “Assign grade” may appear depending on the [http://wiki.expertiza.ncsu.edu/index.php/Deadline_types stage] in which the assignment is.

The following describes the flow of our project considering a fresh assignment.
<ol>
<li>When the assignment is created, it is by default is in the “submission” stage. Hence the user will not see any link on the list submission page.</li>
<li>When the first deadline passes, the assignment goes into the “review” stage. Hence the link “Begin review” will be visible for each team submission, where the instructor/TA can click on to submit the review. Two cases can occur here:
<ul>
<li>If the user “submits” a review, they will be redirected to the list submission page where they’ll see the option “View review” or “Update review.” Being an instructor/TA, they are given the flexibility to update their review at any time during the “review” stage.</li>
<li>If the user “saves” a review, they will be redirected to the list submission page where they’ll see the option “View review” and “Edit Review (as they have not submitted it yet.)”</li>
</li>
</ul>
<li>After the first review is over, if more stages of “submissions” and “reviews” exist, it will follow the above 2 steps until the final assignment deadline does not pass. Note that at any round of the review, the user can “Begin review” for a submission which they had not reviewed in the previous rounds. This is to provide flexibility to them as per the requirement.</li>
<li>Finally, after the assignment deadline passes, the assignment goes into the “Finished” stage. This is when the “Assign grade” link will be visible to the user. Along with this, depending on whether they have reviewed a particular submission or not, the begin, view, update links will be visible to them as they should be able to perform the review even after the assignment deadline for the students has passed.</li>
</ol>

Files Edited 
The following are the files (controllers and views) edited for the implementation of the review process. The comments are given along with the code to explain what is being done. 
* '''Controller: ''' ''app/controllers/response_controller.rb'' 

<pre>
# Ensuring recent submission is not nil
team_most_recent_submission = AssignmentTeam.find(@map.reviewee_id).most_recent_submission
if @response.nil? || (!team_most_recent_submission.nil? && team_most_recent_submission.updated_at > @response.updated_at)
...
# Page should be directed to list_submissions if TA/instructor performs the review
when "ta_review"
redirect_to controller: 'assignments', action: 'list_submissions', id: @map.response_map.assignment.id
</pre>

* '''Controller: ''' ''app/helpers/assignment_helper.rb'' 

<pre>
topic_id = topic.try :id
...
# Needed topic ID for review implpementation, so added it to return list of the function
[topic_id, topic_identifier ||= "", topic_name ||= "", users_for_curr_team, participants]
</pre>

* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' 

<pre>
# Retrieved topic ID for review implpementation
<% topic_id, topic_identifier, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(team) %>
...

<% if @assignment.get_current_stage() == "Finished" %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %> 
<% end %>

<% reviewer = Participant.find_by(:parent_id => @assignment.id, :user_id => session[:user].id)%>


<% if !reviewer.nil? %>

<% @mapping = ReviewResponseMap.find_by(:reviewed_object_id => @assignment.id, :reviewer_id => reviewer.id, :reviewee_id => team.id) %>

<% if @mapping.nil? && (@assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished") %>
<% ReviewResponseMap.create(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% map = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map.id, :return => "ta_review" } %> 

<% elsif @assignment.get_current_stage() == "review" || @assignment.get_current_stage() == "Finished" %>
<% map1 = ReviewResponseMap.find_by(reviewee_id: team.id, reviewer_id: reviewer.id, reviewed_object_id: @assignment.id) %>
<% @sorted_responses = Array.new %>
<% @sorted_responses = Response.where(:map_id => map1.id) %>

<% if @sorted_responses.empty?%>
<%= link_to 'Begin Review', { controller: 'response', action: 'new', :id => map1.id, :return => "ta_review" } %> 
<% else %>

<% @sorted_responses = @sorted_responses.sort_by {|obj| obj.updated_at} # the latest should be at the last %>
<% @latest_response = @sorted_responses.last %>
<%if @latest_response.round.nil?%> 
<% last_response_round = AssignmentDueDate.done_in_assignment_round(@assignment.id, @latest_response) %>
<%else%> 
<% last_response_round = @latest_response.round %>
<%end%>
<% current_round = @assignment.number_of_current_round(topic_id) %>

<%= link_to "View Review", {:controller => 'response', :action => 'view', :id => @latest_response.id} %> 
<% if last_response_round == current_round %>
<% latest_submission = team.most_recent_submission %>
<% if !@latest_response.is_submitted %> 
<%= link_to "Edit Review", {:controller => 'response', :action => 'edit', :id => @latest_response.id, :return => "ta_review" } %>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<%end%>
<% else %> 
<%= link_to "Update Review", {:controller => 'response', :action => 'new', :id => map1.id, :return => "ta_review" } %>
<% end %>
<% end %>
<% end %>
<% end %>
</pre>

* '''View: ''' ''app/views/grades/view_team.html.erb'' 

<pre>

<% topic_id_num, topic_id, topic_name, users_for_curr_team, participants = get_data_for_list_submissions(@team) %>
</pre>

* '''View: ''' ''app/views/student_review/_responses.html.erb'' 

<pre>
# Ensuring recent submission is not nil
<% elsif !latest_submission.nil? && @latest_response.updated_at < latest_submission.updated_at %>
</pre>

---

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Implementation: A simple check is made to determine if the reviewer is a TA or Instructor. app/assets/images/staff.png is displayed to make an instructor performed review stand out from other reviews. If the mouse hovers over the icon a tool tip appears saying "Icon indicates this review was done by course staff" 
[[File:Icon-demo.png|center]]

Files Edited 
* '''Helper: ''' ''app/helpers/grades_helper.rb'' 

<pre>
# Determines if a review was completed by a staff participant (either a TA or an instructor)
# Called in view_team.html to determine if a review should be marked as reviewed by course staff.
def done_by_staff_participant?( review )
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end

# Determines if given participant is a staff participant (either a TA or an instructor)
# Called in views/response/view.html.erb to determine if a review should be marked as reviewed by course staff.
def is_course_staff?( participant )
role = Role.find(User.find(Participant.find(participant.id).user_id).role_id).name
return (role == "Instructor") || (role == "Teaching Assistant")
end
</pre>

* '''View: ''' ''app/views/view_team.html.erb'' 
<pre>
<% if done_by_staff_participant?(review) %>

<th class="sorter-false">
<a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details">
<%= "Review " + i.to_s %></a> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>
</pre>

=== Part 3: Add instructor/TA as a participant while creating the assignment (Extra Feature) ===
 
'''Current scenario''' 
The instructor/TA will be able to perform student reviews (after implementation of Part 1) for the assignment, only when he is a participant of the same assignment. Thus, every time he creates an assignment and wants to add himself as a participant in order to perform student reviews, he is supposed to do the following 
Go to list of assignments -> Find the required assignment -> Click on add participant -> Type user Id -> Click on add
The same flow is as shown below where the instructor/TA has created a new assignment say “Program 1 Github” wherein he wants himself as a participant to be able to perform student reviews :
 
[[File:Addinstructor1.png|center]] 
[[File:AddInstructor2.png]] 
[[File:Add Instructor 3.png]] 

To overcome the hassle, we added a check box through which the instructor/TA will get an option to add himself as a participant while creating the assignment. Also, he will be able to add/remove himself as a participant while editing the assignment.

'''Implementation''' 

The checkbox has been provided to Create New Assignment’s page under the Review strategy tab.
It is added as follows: 

[[File:Add instructor 4.png]] 

If the instructor/TA selects the box while creating the assignment, then he will be added as a participant for the same assignment. 

Files edited:

* '''View: ''' ''app/views/assignments/edit/_review_strategy.html.erb'' 
In this file, code for displaying the checkbox has been added which is as follows :

<pre>
<tr>
<td>
<input name='add_instructor' type="hidden" value="false"/>
<%= check_box_tag('add_instructor', value = "1", checked = is_instructor_a_participant?)%>
<%= label_tag('add_instructor', 'Add yourself as a participant?') %>
<img src="/assets/info.png" title='If you add yourself as a participant then you will be able to perform reviews of students for this assignment'>
</td>
</tr>
</pre>

Thus the checkbox "add_instructor" if selected adds the instructor as a participant to the currently being created assignment. Thus, instructor being a participant allows him to perform reviews for the students for this assignment.

* '''Controller: ''' ''app/controllers/assignments_controller.rb'' 

The file contains extra code which adds the instructor/TA as a participant if the checkbox has been selected while creating the assignment. Also, while editing the assignment, he will be able to add/remove himself as a participant for this assignment. 

The following methods are added to the controller :

<pre>
def is_instructor_a_participant?
instructor_id = session[:user].id
assignment_id = @assignment_form.assignment.id.to_s

if assignment_id != nil
@is_instructor_a_participant = Participant.where(user_id: instructor_id , parent_id: assignment_id)
if @is_instructor_a_participant.present?
return true
end
end
return false
end
</pre>

The method "is_instructor_a_participant?" returns true if the instructor is already a participant for the assignment, else returns false. This method is required to verify that the instructor/TA is not a participant of the assignment, and thus he can be added as a participant if the checkbox has been selected. Also, during editing the assignment, we need to show checkbox being selected if the instructor is a participant and vice versa. Thus, this method serves that purpose as well.

 
<pre>
def add_instructor_as_participant(assignment_id)
if params[:add_instructor] == 'false' and is_instructor_a_participant? == true
delete_instructor_as_participant(assignment_id,session[:user].id)
elsif params[:add_instructor] == '1' and is_instructor_a_participant? == false
current_assignment = Object.const_get("Assignment").find(assignment_id)
current_assignment.add_participant(session[:user].name, true, true, true)
end
end
</pre>

The method "add_instructor_as_participant" is been called from create and update methods in the Assignment controller. It checks if the "Add yourself as participant" checkbox is selected for the currently created/edited assignment. If it is selected during creation or editing, then the instructor is added as a participant to the currently created/edited assignment. The participant is added by using the already existing method "add_participant" in the model assignment.rb Also, if the option is unchecked during editing, then the instructor is removed as a participant.

 
<pre>
def delete_instructor_as_participant(assignment_id , instructor_id)
Participant.where(user_id: instructor_id , parent_id: assignment_id).destroy_all
end
</pre>
The method "delete_instructor_as_participant" removes instructor as a participant for the assignment when the checkbox is unchecked during the editing of the assignment.

== '''Test Plan''' ==

==== Part 1: Allowing instructor/TA to perform review ====
UI Testing

<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li>Choose any assignment from the list of assignments which involves teams; since an assignment without teams does not include the review procedure. For example, “Final project (design and doc)” is a good assignment to choose.
<li>Now, while testing this functionality, it is recommended to keep the following pages opened in different tabs by clicking on the small icons in the same row as the assignment that you want to test: 

a. “Edit” -> “Due Dates” tab
[[File:edit_assignment.png]] 

b. “Add participants”
[[File:add_as_participant.png]] 

c. “View Submissions”
[[File:list_submissions.png]] 
</li>
<li>Now add the instructor as a participant (3.b). and edit the ALL due dates (3.a.) of different stages to any date later from now (hence the assignment goes into the “submission” stage by default). Save both these changes. </li>
<li>Now refresh the view submissions page (3.c.), you will see a list of assignments with no link to review or assign grade.</li>
<li>Now switch to edit due dates tab (3.a.) again. Set the due date for submission to a previous date which has passed, hence the next due date will be for the “review” stage by default (which will have a later due date from now.)</li>
<li>Refresh view submissions page (3.c.), you will see a list of assignments with a link to “Begin Review.”</li>
<li>You can click on it. If you “save” your response, you will see that the link has been replace by “View review” and “Edit review” now. Whereas, if you “submit” the response, the link will be replaced by “View review” and “Update review.”</li>
<li>Depending on the number of stages that an assignment has, you can edit the due date at every stage and check whether the links are displayed appropriately.</li>
<li>Finally when the last deadline of the assignment is set to a previous date which has passed, you will see the link to “Assign grade” in view submissions (3.c.), and the user will still be able to begin, edit or update a review in order to provide flexibility as per the requirements.</li>
</ol>

Edge Cases:
<ol>
<li>If the user is not a participant of the current assignment, they are shown a list of all submissions made by all teams of the current assignment. They are shown the link to “Assign Grade” only when the final deadline of the assignment passes.</li>
<li>During any review stage or even after the deadline, the user is offered the flexibility to Begin, Edit, View or Update their review.</li>
</ol>

=== Part 2: Allow students to identify that their submission has been reviewed by the instructor===
UI Testing
<ol>
<li>Login in as student. Here we have logged in as student8434
<ul>
<li>Username: student8434</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Assignments-> Final project (and design doc)</li>
<li> Click on Your scores</li>

There we can see the icon for reviews reviewed by staff.

===Part 3: Add instructor/TA as a participant while creating the assignment===
UI Testing
<ol>
<li>Login in as an instructor.
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul> </li>
<li> Go to Manage-> Assignments </li>
<li> Click on add assignment </li>
<li> Enter the required details- Assignment name, course etc </li>
<li>To add instructor/TA as a participant, go to Review Tab and select the "Add yourself as a participant?" checkbox. </li>
<li> Click on Save </li>

The assignment has been created and the instructor/TA is added as a participant to the assignment.
</ol>

Edge Cases :
<ol>
<li> If the instructor/TA does not select the "Add yourself as a participant?" checkbox while creating the assignment, then he is not added as a participant</li>
<li> If the instructor/TA selects the "Add yourself as a participant?" checkbox while editing the assignment, then he is added as a participant
<li> If the instructor/TA unchecks the "Add yourself as a participant?" checkbox while editing the assignment, then he is removed as a participant </li> </ol>

 
Rspec Testing :
<pre>

describe '#create' do
before(:each) do
allow(AssignmentForm).to receive(:new).with(any_args).and_return(assignment_form)
@params = {
button: '',
assignment_form: {
assignment_questionnaire: [{"assignment_id" => "1", "questionnaire_id" => "666", "dropdown" => "true",
"questionnaire_weight" => "100", "notification_limit" => "15", "used_in_round" => "1"}],
due_date: [{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "1", "due_at" => "2017/12/05 00:00", "submission_allowed_id" => "3", "review_allowed_id" => "1", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"},
{"id" => "", "parent_id" => "", "round" => "1", "deadline_type_id" => "2", "due_at" => "2017/12/02 00:00", "submission_allowed_id" => "1", "review_allowed_id" => "3", "teammate_review_allowed_id" => "3", "review_of_review_allowed_id" => "1", "threshold" => "1"}],
assignment: {
instructor_id: 2,
course_id: 1,
max_team_size: 1,
id: 1,
name: 'test assignment',
directory_path: '/test',
spec_location: '',
private: false,
show_teammate_reviews: false,
require_quiz: false,
num_quiz_questions: 0,
staggered_deadline: false,
microtask: false,
reviews_visible_to_all: false,
is_calibrated: false,
availability_flag: true,
reputation_algorithm: 'Lauw',
simicheck: -1,
simicheck_threshold: 100
add_instructor:1 #added field
}
}
}

context 'when assignment_form is saved successfully' do
it 'redirects to assignment#edit page' do
allow(assignment_form).to receive(:assignment).and_return(assignment)
allow(assignment_form).to receive(:save).and_return(true)
allow(assignment_form).to receive(:update).with(any_args).and_return(true)
allow(assignment_form).to receive(:create_assignment_node).and_return(double('node'))
allow(assignment).to receive(:id).and_return(1)
allow(Assignment).to receive(:find_by).with(name: 'test assignment').and_return(assignment)
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
allow_any_instance_of(AssignmentsController).to receive(:undo_link)
.with('Assignment "test assignment" has been created successfully. ').and_return(true)
post :create, @params
expect(response).to redirect_to('/assignments/1/edit')
end
end

describe '#update' do
context 'when params does not have key :assignment_form' do
context 'when assignment is saved successfully' do
it 'shows a note flash message and redirects to tree_display#index page' do
allow(assignment).to receive(:save).and_return(true)
params = {
id: 1,
course_id: 1
}
session = {user: instructor}
allow(assignment_form).to receive(:add_instructor_as_participant).with(any_args).and_return(true) #added check
post :update, params, session
expect(flash[:note]).to eq('The assignment was successfully saved.')
expect(response).to redirect_to('/tree_display/list')
end
end

context 'when "Add yourself as a participant?" checkbox is selected' do
it 'calls add_instructor_as_participant which in turn calls add Participant method of Participant controller' do
allow(assignment_form).to receive(:add_participant).with(any_args).and_return(true)
end
end

</pre>

== '''External Links''' ==
* Forked Repository: https://github.com/Matrawick/expertiza/tree/beta
* Pull Request: https://github.com/expertiza/expertiza/pull/1631

== '''Team Members''' ==
Mentor: Prof. Edward Gehringer (efg@ncsu.edu)
<ul>
<li>Anuja Kulkarni - apkulka2@ncsu.edu</li>
<li>Mark Trawick - mtrawic@ncsu.edu</li>
<li>Parvathy Menon - pharida@ncsu.edu</li>
<li>Samruddhi Khandale - sskhanda@ncsu.edu</li>
</ul>

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-11-11T21:45:24Z

Pharida: /* Issue : Show students that her/his assignment has been reviewed by the instructor */

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know what tone to use or what suggestion to make.

By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience.

==''' Current Scenario and Proposed Implementations''' ==

=== Issue: Allow TA / Instructor to perform review of student assignments ===
Current Scenario:
Instructors and TA's can not perform reviews. Previous attempts were made but they either complicated the code or did not pass the Travis CI. For this particular task, the following screenshot describes how the current scenario looks. The page below is the “View Submissions” page when logged in as an instructor. 
[[File:list1.png]] 

Requirement:
This functionality is needed so that the instructors can easily perform submission reviews which can also be viewed by the students. Also for future purposes, other student reviews can be bench marked against an instructor review. 

Proposed Implementation: The following things need to be improved/changed with respect to the above screenshot.
 The second column consists of the title name with the link to “Assign Grade.” This is the part which we will have to modify. The link under the project title should be as follows : 
1. “Perform Review,” until the deadline for the assignment hasn’t been reached. If he/she has already started the review, the link will be modified to “Edit Review,” until they don’t submit it. 
2. “Assign Grade,” after the deadline of the assignment passes. 
When clicked on “Perform Review”/”Edit Review,” it should direct to the review page seen by the students, and be able to perform the review. Thus it will direct the page to the response#new page or response#edit page respectively. 
For the above-mentioned flow, the following file will be edited: 
app/views/assignments/list_submissions.html.erb:
This view file refers to the page in the above screenshot. This file will be edited to check whether the deadline for the current assignment has been passed, and accordingly it will display either of the two options denoted above.

----

=== Issue: Allow TA/Instructor to add himself as a participant ===
 Current scenario : Instructors and TA's can add themselves as participants. 
 Requirement : The teaching staff reviewing a previous project thought this might be a bad idea. Here's what they said about it in our project description. "It adds instructor to the assignment as a participant. This is probably not a good idea, because the instructor can review everyone, independent of what reviewer-assignment mechanism was in use."

 Proposed Implementation : We need to find out how doing a review works. I'm guessing by adding the instructor as a participant makes it easy to do a review. If we don't tell let the instructor add themselves as a participant then we may need to add code in the part for setting up reviews. We will need a link in the list_submissions_.html.erb for "perform review".

----

===Issue : Method to check if the user is instructor / TA for the selected course ===
 Current scenario : There is no method which checks if the user is an instructor / TA for the selected course (namely a course staff member) 
Requirement : This method is required for redirection of pages which is dependent on the user role. Also, it is required to identify if the review is performed by the course staff. 
Proposed implementation : A new helper file named course_staff_helper.rb will be created in expertiza/helpers/ which will consist a method which checks if the user is a course staff member. 

----

===Issue : Show students that her/his assignment has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Proposed Implementation: An icon will be added in the file app/assets/stylesheets/grades.scss to make an instructor performed review look different from other reviews.

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-11-11T21:45:09Z

Pharida: /* Issue : Show students that her/his assignment has been reviewed by the instructor */

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know what tone to use or what suggestion to make.

By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience.

==''' Current Scenario and Proposed Implementations''' ==

=== Issue: Allow TA / Instructor to perform review of student assignments ===
Current Scenario:
Instructors and TA's can not perform reviews. Previous attempts were made but they either complicated the code or did not pass the Travis CI. For this particular task, the following screenshot describes how the current scenario looks. The page below is the “View Submissions” page when logged in as an instructor. 
[[File:list1.png]] 

Requirement:
This functionality is needed so that the instructors can easily perform submission reviews which can also be viewed by the students. Also for future purposes, other student reviews can be bench marked against an instructor review. 

Proposed Implementation: The following things need to be improved/changed with respect to the above screenshot.
 The second column consists of the title name with the link to “Assign Grade.” This is the part which we will have to modify. The link under the project title should be as follows : 
1. “Perform Review,” until the deadline for the assignment hasn’t been reached. If he/she has already started the review, the link will be modified to “Edit Review,” until they don’t submit it. 
2. “Assign Grade,” after the deadline of the assignment passes. 
When clicked on “Perform Review”/”Edit Review,” it should direct to the review page seen by the students, and be able to perform the review. Thus it will direct the page to the response#new page or response#edit page respectively. 
For the above-mentioned flow, the following file will be edited: 
app/views/assignments/list_submissions.html.erb:
This view file refers to the page in the above screenshot. This file will be edited to check whether the deadline for the current assignment has been passed, and accordingly it will display either of the two options denoted above.

----

=== Issue: Allow TA/Instructor to add himself as a participant ===
 Current scenario : Instructors and TA's can add themselves as participants. 
 Requirement : The teaching staff reviewing a previous project thought this might be a bad idea. Here's what they said about it in our project description. "It adds instructor to the assignment as a participant. This is probably not a good idea, because the instructor can review everyone, independent of what reviewer-assignment mechanism was in use."

 Proposed Implementation : We need to find out how doing a review works. I'm guessing by adding the instructor as a participant makes it easy to do a review. If we don't tell let the instructor add themselves as a participant then we may need to add code in the part for setting up reviews. We will need a link in the list_submissions_.html.erb for "perform review".

----

===Issue : Method to check if the user is instructor / TA for the selected course ===
 Current scenario : There is no method which checks if the user is an instructor / TA for the selected course (namely a course staff member) 
Requirement : This method is required for redirection of pages which is dependent on the user role. Also, it is required to identify if the review is performed by the course staff. 
Proposed implementation : A new helper file named course_staff_helper.rb will be created in expertiza/helpers/ which will consist a method which checks if the user is a course staff member. 

----

===Issue : Show students that her/his assignment has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Proposed Implementation: An icon will be added in the file app/assets/stylesheets/grades.scss to make an instructor performed review look different from other reviews.

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-11-11T21:44:50Z

Pharida: /* Issue : Show students that her/his assignment has been reviewed by the instructor */

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know what tone to use or what suggestion to make.

By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience.

==''' Current Scenario and Proposed Implementations''' ==

=== Issue: Allow TA / Instructor to perform review of student assignments ===
Current Scenario:
Instructors and TA's can not perform reviews. Previous attempts were made but they either complicated the code or did not pass the Travis CI. For this particular task, the following screenshot describes how the current scenario looks. The page below is the “View Submissions” page when logged in as an instructor. 
[[File:list1.png]] 

Requirement:
This functionality is needed so that the instructors can easily perform submission reviews which can also be viewed by the students. Also for future purposes, other student reviews can be bench marked against an instructor review. 

Proposed Implementation: The following things need to be improved/changed with respect to the above screenshot.
 The second column consists of the title name with the link to “Assign Grade.” This is the part which we will have to modify. The link under the project title should be as follows : 
1. “Perform Review,” until the deadline for the assignment hasn’t been reached. If he/she has already started the review, the link will be modified to “Edit Review,” until they don’t submit it. 
2. “Assign Grade,” after the deadline of the assignment passes. 
When clicked on “Perform Review”/”Edit Review,” it should direct to the review page seen by the students, and be able to perform the review. Thus it will direct the page to the response#new page or response#edit page respectively. 
For the above-mentioned flow, the following file will be edited: 
app/views/assignments/list_submissions.html.erb:
This view file refers to the page in the above screenshot. This file will be edited to check whether the deadline for the current assignment has been passed, and accordingly it will display either of the two options denoted above.

----

=== Issue: Allow TA/Instructor to add himself as a participant ===
 Current scenario : Instructors and TA's can add themselves as participants. 
 Requirement : The teaching staff reviewing a previous project thought this might be a bad idea. Here's what they said about it in our project description. "It adds instructor to the assignment as a participant. This is probably not a good idea, because the instructor can review everyone, independent of what reviewer-assignment mechanism was in use."

 Proposed Implementation : We need to find out how doing a review works. I'm guessing by adding the instructor as a participant makes it easy to do a review. If we don't tell let the instructor add themselves as a participant then we may need to add code in the part for setting up reviews. We will need a link in the list_submissions_.html.erb for "perform review".

----

===Issue : Method to check if the user is instructor / TA for the selected course ===
 Current scenario : There is no method which checks if the user is an instructor / TA for the selected course (namely a course staff member) 
Requirement : This method is required for redirection of pages which is dependent on the user role. Also, it is required to identify if the review is performed by the course staff. 
Proposed implementation : A new helper file named course_staff_helper.rb will be created in expertiza/helpers/ which will consist a method which checks if the user is a course staff member. 

----

===Issue : Show students that her/his assignment has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement: This helps the student to identify the review made by the instructor from the other reviews. 
Proposed Implementation: An icon will be added in the file app/assets/stylesheets/grades.scss to make an instructor performed review look different from other reviews.

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-11-11T21:41:02Z

Pharida: /* Issue : Show students that her/his assignment has been reviewed by the instructor */

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know what tone to use or what suggestion to make.

By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience.

==''' Current Scenario and Proposed Implementations''' ==

=== Issue: Allow TA / Instructor to perform review of student assignments ===
Current Scenario:
Instructors and TA's can not perform reviews. Previous attempts were made but they either complicated the code or did not pass the Travis CI. For this particular task, the following screenshot describes how the current scenario looks. The page below is the “View Submissions” page when logged in as an instructor. 
[[File:list1.png]] 

Requirement:
This functionality is needed so that the instructors can easily perform submission reviews which can also be viewed by the students. Also for future purposes, other student reviews can be bench marked against an instructor review. 

Proposed Implementation: The following things need to be improved/changed with respect to the above screenshot.
 The second column consists of the title name with the link to “Assign Grade.” This is the part which we will have to modify. The link under the project title should be as follows : 
1. “Perform Review,” until the deadline for the assignment hasn’t been reached. If he/she has already started the review, the link will be modified to “Edit Review,” until they don’t submit it. 
2. “Assign Grade,” after the deadline of the assignment passes. 
When clicked on “Perform Review”/”Edit Review,” it should direct to the review page seen by the students, and be able to perform the review. Thus it will direct the page to the response#new page or response#edit page respectively. 
For the above-mentioned flow, the following file will be edited: 
app/views/assignments/list_submissions.html.erb:
This view file refers to the page in the above screenshot. This file will be edited to check whether the deadline for the current assignment has been passed, and accordingly it will display either of the two options denoted above.

=== Issue: Allow TA/Instructor to add himself as a participant ===
 Current scenario : Instructors and TA's can add themselves as participants. 
 Requirement : The teaching staff reviewing a previous project thought this might be a bad idea. Here's what they said about it in our project description. "It adds instructor to the assignment as a participant. This is probably not a good idea, because the instructor can review everyone, independent of what reviewer-assignment mechanism was in use."

 Proposed Implementation : We need to find out how doing a review works. I'm guessing by adding the instructor as a participant makes it easy to do a review. If we don't tell let the instructor add themselves as a participant then we may need to add code in the part for setting up reviews. We will need a link in the list_submissions_.html.erb for "perform review".

===Issue : Method to check if the user is instructor / TA for the selected course ===
 Current scenario : There is no method which checks if the user is an instructor / TA for the selected course (namely a course staff member) 
Requirement : This method is required for redirection of pages which is dependent on the user role. Also, it is required to identify if the review is performed by the course staff. 
Proposed implementation : A new helper file named course_staff_helper.rb will be created in expertiza/helpers/ which will consist a method which checks if the user is a course staff member. 

===Issue : Show students that her/his assignment has been reviewed by the instructor===
 Currently Scenario: There is no way for the student to know which review was by the instructor. 
Requirement:
Proposed Implementation: An icon will be added in the file app/assets/stylesheets/grades.scss to make an instructor performed review look different from other reviews.

CSC/ECE 517 Fall 2019 - E1985. Let course staff and students do reviews

2019-11-11T02:51:30Z

Pharida:

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know what tone to use or what suggestion to make.

By letting course staff perform reviews as well, the reviewer and the reviewee both benefit, improving the overall learning experience.

=== Current scenario ===

===Issue : Method to check if user is instructor / TA for selected course ===
Currently, there is no method which checks if the user is an instructor / TA for the selected course (namely a course staff member) Need : This method is required for redirection of pages which is dependent on the user role. Also, it is required to identify if the review is performed by the course staff. 
Proposed implementation : A new helper file named course_staff_helper.rb will be created in expertiza/helpers/ which will consist a method which checks if the user is a course staff member. 

=== Issue: Allow TA/Instructor to add himself as a participant ===
Currently instructors and TA's can add themselves as participants. The teaching staff reviewing a previous project thought this might be a bad idea. Here's what they said about it in our project description. "It adds instructor to the assgt. as a participant. This is probably not a good idea, because the instructor can review everyone, independent of what reviewer-assignment mechanism was in use."

I need to find out how doing a review works. I'm guessing by adding the instructor as a participant makes it easy to do a review. If we don't tell let the instructor add themselves as a participant then we may need to add code in the part for setting up reviews.

We will need a link in the list_submissions_.html.erb for "perform review".

===Issue : Show students that her/his assignment has been reviewed by the instructor===
Currently Scenario: 
Proposed Implementation: An icon will be added in the file app/assets/stylesheets/grades.scss to make an instructor performed review look different from other reviews. 
=== Issue: Allow TA/Instructor to perform review of student assignments ===
Current Scenario: 
Currently, instructors and TA's cannot perform reviews. Previous attempts were made but they either complicated the code or did not pass the Travis CI. For this particular task, the following screenshot describes how the current scenario looks and what needs to be improved/changed about it. The page below is the “View Submissions” page when logged in as an instructor. 
[[File:list1.png]] 
The 2nd column consists of the title name with the link to “Assign Grade.” This is the part which we will have to modify. The link under the project title should be: 
1. “Perform Review,” until the deadline for the assignment hasn’t been reached. If he/she has already started the review, the link will be modified to “Edit Review,” until they don’t submit it. 
2. “Assign Grade,” after the deadline of the assignment passes. 
When clicked on “Perform Review”/”Edit Review,” it should direct to the review page seen by the students, and be able to perform the review. Thus it will direct the page to the response#new page or response#edit page respectively. 

Need: 
This functionality is needed so that the instructors can easily perform submission reviews which can also be viewed by the students. Also for future purposes, other student reviews can be benchmarked against an instructor review. 

Proposed Implementation: 
For the above-mentioned flow, the following file will be edited: 
app/views/assignments/list_submissions.html.erb:
This view file refers to the page in the above screenshot. This file will be edited to check whether the deadline for the current assignment has been passed, and accordingly it will display either of the 2 options denoted above.

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T03:22:22Z

Pharida:

=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1384: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue1430: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

==Issue1384==

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

Two new flags in the user database namely preference_home_flag and preference_edit_flag were created which were initialized to be true and the user would see a checkbox for both of his preference in the profile page which would both be initially checked to be true. Now user can uncheck this to see where he/she wants to see the operations. We implemented them both on local. We tried to use one of the flags as a text box and tried to insert text values in the profile page and could not accomplish the expected output as the flag was not updating.

'''app/controllers/users_controller.rb'''
====Before====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id)
end
</pre>

====After====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id,
:preference_home_flag,
:preference_edit_flag)
end
</pre>

====Added====
'''app/views/users/_editpreference.html.erb'''
<pre>
<%#created two checkboxes where the user can select where he wants to make the assignment operations visible %>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>
<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''db/migrate/20191028210443_add_preference_edit_flag_to_users.rb'''

<pre>
class AddPreferenceEditFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_edit_flag, :boolean , :default => true
end
end
</pre>

<pre>
class AddPreferenceHomeFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_home_flag, :boolean , :default => true
end
end
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%#added a new part in the front end for users to choose the options to see the assignment operations %>
<%= render :partial => 'users/editpreference' %>
</pre>

==Issue1430==

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

Only those courses are shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to. Instructors, but not TAs, would be allowed to change an assignment to be part of no course. Also, changed the name of the tab from “Other stuff” to “Etc.”.

'''app/helpers/assignment_helper.rb'''

====Before====
<pre>
module AssignmentHelper
def course_options(instructor)
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
courses = Course.all
elsif session[:user].role.name == 'Instructor'
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
@@ -21,8 +25,7 @@ def course_options(instructor)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

====After====
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
#the course corresponding to each TA will be added to the dropdown.
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
# Only SuperAdmin and Admin can have the right to make an assignment to a nil course.
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
# Only SuperAdmin and Admin can have the right to make an assignment to a nil course.
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

=Testing=
Travis-CI Build Testing
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.

[[File:Exp1386.jpeg]]

[[File:Exp1430.jpeg]]

=Team Information=
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T03:21:13Z

Pharida:

=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1384: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue1430: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

==Issue1384==

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

Two new flags in the user database namely preference_home_flag and preference_edit_flag were created which were initialized to be true and the user would see a checkbox for both of his preference in the profile page which would both be initially checked to be true. Now user can uncheck this to see where he/she wants to see the operations. We implemented them both on local. We tried to use one of the flags as a text box and tried to insert text values in the profile page and could not accomplish the expected output as the flag was not updating.

'''app/controllers/users_controller.rb'''
====Before====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id)
end
</pre>

====After====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id,
:preference_home_flag,
:preference_edit_flag)
end
</pre>

====Added====
'''app/views/users/_editpreference.html.erb'''
<pre>
<%#created two checkboxes where the user can select where he wants to make the assignment operations visible %>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>
<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''db/migrate/20191028210443_add_preference_edit_flag_to_users.rb'''

<pre>
class AddPreferenceEditFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_edit_flag, :boolean , :default => true
end
end
</pre>

<pre>
class AddPreferenceHomeFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_home_flag, :boolean , :default => true
end
end
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%#added a new part in the front end for users to choose the options to see the assignment operations %>
<%= render :partial => 'users/editpreference' %>
</pre>

==Issue1430==

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

Only those courses are shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to. Instructors, but not TAs, would be allowed to change an assignment to be part of no course. Also, changed the name of the tab from “Other stuff” to “Etc.”.

'''app/helpers/assignment_helper.rb'''

====Before====
<pre>
module AssignmentHelper
def course_options(instructor)
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
courses = Course.all
elsif session[:user].role.name == 'Instructor'
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
@@ -21,8 +25,7 @@ def course_options(instructor)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

====After====
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
#the course corresponding to each TA will be added to the dropdown.
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
# Only SuperAdmin and Admin can have the right to make an assignment to a nil course.
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

=Testing=
Travis-CI Build Testing
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.

[[File:Exp1386.jpeg]]

[[File:Exp1430.jpeg]]

=Team Information=
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T03:18:05Z

Pharida:

=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1384: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue1430: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

==Issue1384==

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

Two new flags in the user database namely preference_home_flag and preference_edit_flag were created which were initialized to be true and the user would see a checkbox for both of his preference in the profile page which would both be initially checked to be true. Now user can uncheck this to see where he/she wants to see the operations. We implemented them both on local. We tried to use one of the flags as a text box and tried to insert text values in the profile page and could not accomplish the expected output as the flag was not updating.

'''app/controllers/users_controller.rb'''
====Before====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id)
end
</pre>

====After====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id,
:preference_home_flag,
:preference_edit_flag)
end
</pre>

====Added====
'''app/views/users/_editpreference.html.erb'''
<pre>
<%#created two checkboxes where the user can select where he wants to make the assignment operations visible %>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>
<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''db/migrate/20191028210443_add_preference_edit_flag_to_users.rb'''

<pre>
class AddPreferenceEditFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_edit_flag, :boolean , :default => true
end
end
</pre>

<pre>
class AddPreferenceHomeFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_home_flag, :boolean , :default => true
end
end
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%#added a new part in the front end for users to choose the options to see the assignment operations %>
<%= render :partial => 'users/editpreference' %>
</pre>

==Issue1430==

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

Only those courses are shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to. Instructors, but not TAs, would be allowed to change an assignment to be part of no course. Also, changed the name of the tab from “Other stuff” to “Etc.”.

====After====
'''app/helpers/assignment_helper.rb'''
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
#the course corresponding to each TA will be added to the dropdown.
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
# Only SuperAdmin and Admin can have the right to make an assignment to a nil course.
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

=Testing=
Travis-CI Build Testing
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.

[[File:Exp1386.jpeg]]

[[File:Exp1430.jpeg]]

=Team Information=
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T03:16:48Z

Pharida:

=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1384: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue1430: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

==Issue1384==

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

Two new flags in the user database namely preference_home_flag and preference_edit_flag were created which were initialized to be true and the user would see a checkbox for both of his preference in the profile page which would both be initially checked to be true. Now user can uncheck this to see where he/she wants to see the operations. We implemented them both on local. We tried to use one of the flags as a text box and tried to insert text values in the profile page and weren't successful as the flag was not updating.

'''app/controllers/users_controller.rb'''
====Before====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id)
end
</pre>

====After====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id,
:preference_home_flag,
:preference_edit_flag)
end
</pre>

====Added====
'''app/views/users/_editpreference.html.erb'''
<pre>
<%#created two checkboxes where the user can select where he wants to make the assignment operations visible %>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>
<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''db/migrate/20191028210443_add_preference_edit_flag_to_users.rb'''

<pre>
class AddPreferenceEditFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_edit_flag, :boolean , :default => true
end
end
</pre>

<pre>
class AddPreferenceHomeFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_home_flag, :boolean , :default => true
end
end
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%#added a new part in the front end for users to choose the options to see the assignment operations %>
<%= render :partial => 'users/editpreference' %>
</pre>

==Issue1430==

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

Only those courses are shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to. Instructors, but not TAs, would be allowed to change an assignment to be part of no course. Also, changed the name of the tab from “Other stuff” to “Etc.”.

'''app/helpers/assignment_helper.rb'''
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
#the course corresponding to each TA will be added to the dropdown.
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
# Only SuperAdmin and Admin can have the right to make an assignment to a nil course.
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

=Testing=
Travis-CI Build Testing
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.

[[File:Exp1386.jpeg]]

[[File:Exp1430.jpeg]]

=Team Information=
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:34:49Z

Pharida:

=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1384: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue1430: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

==Issue1384==

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

'''app/controllers/users_controller.rb'''
====Before====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id)
end
</pre>

====After====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id,
:preference_home_flag,
:preference_edit_flag)
end
</pre>

====Added====
'''app/views/users/_editpreference.html.erb'''
<pre>
<%#created two checkboxes where the user can select where he wants to make the assignment operations visible %>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>
<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''db/migrate/20191028210443_add_preference_edit_flag_to_users.rb'''

<pre>
class AddPreferenceEditFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_edit_flag, :boolean , :default => true
end
end
</pre>

<pre>
class AddPreferenceHomeFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_home_flag, :boolean , :default => true
end
end
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%#added a new part in the front end for users to choose the options to see the assignment operations %>
<%= render :partial => 'users/editpreference' %>
</pre>

==Issue1430==

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

'''app/helpers/assignment_helper.rb'''
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#assigments =
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

=Testing=
Travis-CI Build Testing
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.

[[File:Exp1386.jpeg]]

[[File:Exp1430.jpeg]]

=Team Information=
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:32:58Z

Pharida:

=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1384: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue1430: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

==Issue1384==

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

'''app/controllers/users_controller.rb'''
====Before====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id)
end
</pre>

====After====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id,
:preference_home_flag,
:preference_edit_flag)
end
</pre>

====Added====
'''app/views/users/_editpreference.html.erb'''
<pre>
<%#created two checkboxes where the user can select where he wants to make the assignment operations visible %>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>
<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''db/migrate/20191028210443_add_preference_edit_flag_to_users.rb'''

<pre>
class AddPreferenceEditFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_edit_flag, :boolean , :default => true
end
end
</pre>

<pre>
class AddPreferenceHomeFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_home_flag, :boolean , :default => true
end
end
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%= render :partial => 'users/editpreference' %>
</pre>

==Issue1430==

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

'''app/helpers/assignment_helper.rb'''
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#assigments =
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

=Testing=
Travis-CI Build Testing
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.

[[File:Exp1386.jpeg]]

[[File:Exp1430.jpeg]]

=Team Information=
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:32:10Z

Pharida:

=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1384: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue1430: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

==Issue1384==

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

'''app/controllers/users_controller.rb'''
====Before====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id)
end
</pre>

====After====
<pre>
def user_params
params.require(:user).permit(:name,
:crypted_password,
:role_id,
:password_salt,
:fullname,
:email,
:parent_id,
:private_by_default,
:mru_directory_path,
:email_on_review,
:email_on_submission,
:email_on_review_of_review,
:is_new_user,
:master_permission_granted,
:handle,
:digital_certificate,
:persistence_token,
:timezonepref,
:public_key,
:copy_of_emails,
:institution_id,
:preference_home_flag,
:preference_edit_flag)
end
</pre>

====Added====
'''app/views/users/_editpreference.html.erb'''
<pre>
<%#created two checkboxes where the user can select where he wants to make the assignment operations visible %>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>
<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%= render :partial => 'users/editpreference' %>
</pre>

'''db/migrate/20191028210443_add_preference_edit_flag_to_users.rb''

<pre>
class AddPreferenceEditFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_edit_flag, :boolean , :default => true
end
end
</pre>

<pre>
class AddPreferenceHomeFlagToUsers < ActiveRecord::Migration
def change
add_column :users, :preference_home_flag, :boolean , :default => true
end
end
</pre>

==Issue1430==

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

'''app/helpers/assignment_helper.rb'''
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#assigments =
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

=Testing=
Travis-CI Build Testing
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.

[[File:Exp1386.jpeg]]

[[File:Exp1430.jpeg]]

=Team Information=
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:30:26Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:30:00Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:22:01Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:21:29Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T02:18:56Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T00:27:54Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T00:26:56Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T00:25:33Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T00:24:53Z

Pharida:

File:Exp1430.jpeg

2019-11-07T00:24:18Z

Pharida:

File:Exp1386.jpeg

2019-11-07T00:23:59Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T00:22:15Z

Pharida:

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-11-07T00:21:46Z

Pharida:

[[File:Example.jpg]]=Introduction=

===Background===
Expertiza has Assignment objects, which represent an assignment that is done by some number of users. An instructor or a TA can perform several kinds of operations on assignments, such as, ”Add participants”, “Create teams”, and “View scores”. These operations can be seen:
First, on the homepage, under the “Actions” column in assignment list when a user (instructor or TA or admin) logs in and navigates to Manage -> Assignments.

Second, when editing an assignment (by clicking on edit logo above), on the tab called “Other stuff”.

__TOC__

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

* Issue1: Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

* Issue2: Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.
What is wrong:
A TA or an instructor can assign any course to an assignment even when they don't have access to the course.
TAs can unassign an assignment from the course, and if they do so, they lose access to the assignment.
What needs to be done:

Only those courses should be shown in the dropdown list of courses, the assignment is part of and the instructor or TA has access to.
Instructors, but not TAs, would then be allowed to change an assignment to be part of no course.
Also, change the name of the tab from “Other stuff” to “Etc.”.

====Issue1====

* Implement a setting in the user’s (instructor/ TA) profile, from where the user can choose whether to see these actions on the homepage or in a tab associated with each assignment.

'''app/views/users/_editpreference.html.erb'''
<pre>
<% request_user ||= false %>
<%if !request_user%>
<div>
<table class="table borderless">
<tr>
<th align='left'>Where do you want to see actions?</th>
</tr>
<tr>

<td><%= label_tag('user[preference_home_flag]', 'On the homepage')%></td>
<td><%= check_box 'user', 'preference_home_flag', {}, true, false %></td>
</tr>
<tr>
<td><label for="user_preference_edit_flag">On the edit Assignment Page</label></td>
<td><%= check_box 'user', 'preference_edit_flag', {}, true, false %></td>
</tr>
<tr>
</table>
</div>
<% end %>
</pre>

'''app/views/profile/edit.html.erb'''
<pre>
<%= render :partial => 'users/editpreference' %>
</pre>

====Issue2====

* Under the “General” tab of the assignment edit page, an instructor or a TA can change the course of an assignment.

'''app/helpers/assignment_helper.rb'''
<pre>

module AssignmentHelper
def course_options(instructor)
options = []
if session[:user].role.name == 'Teaching Assistant'
courses = []
ta = Ta.find(session[:user].id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# If a TA created some courses before, s/he can still add new assignments to these courses.
courses << Course.where(instructor_id: instructor.id)
#assigments =
#courses << Course.where(instructor_id: instructor.id)
courses.flatten!
# Administrator and Super-Administrator can see all courses
elsif session[:user].role.name == 'Administrator' or session[:user].role.name == 'Super-Administrator'
options << ['-----------', nil]
courses = Course.all
elsif session[:user].role.name == 'Instructor'
options << ['-----------', nil]
courses = Course.where(instructor_id: instructor.id)
# instructor can see courses his/her TAs created
ta_ids = []
ta_ids << Instructor.get_my_tas(session[:user].id)
ta_ids.flatten!
ta_ids.each do |ta_id|
ta = Ta.find(ta_id)
ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
end
# ta_ids = []
# ta_ids << Instructor.get_my_tas(session[:user].id)
# ta_ids.flatten!
# ta_ids.each do |ta_id|
# ta = Ta.find(ta_id)
# ta.ta_mappings.each {|mapping| courses << Course.find(mapping.course_id) }
# end
end
options = []
options << ['-----------', nil]

courses.each do |course|
options << [course.name, course.id]
end
</pre>

'''app/views/assignments/edit.html.erb'''
<pre>

<li><a href="#tabs-8" id="Other">etc</a></li>
</pre>

===Process Video===

===Test===
[[File:Example.jpg]]
===Team Information===
#Parvathy Haridas Menon (pharida@ncsu.edu)
#Anmol Desai (adesai5@ncsu.edu)
#Suyash Jain (sjain26@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management

2019-10-29T01:59:54Z

Pharida: