Expertiza_Wiki - User contributions [en]

E1863 Issues related to assignment creation

2018-12-11T20:43:18Z

Zmathew: /* Test Plan */

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were some issues related to the assignment creation. The main motive behind this project is to fix these issues and provide improved functionalities.

There are in all 5 issues that are being dealt within this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Implementation===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented:
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to delete any assignment that shows up in the list without the need for matching the assignment Id with it's own and giving Instructor the ability to delete any assignment created by a TA.

===Implementation===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:E1863-Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller.

The code at present checks for the current user and allows it the permission to delete the file if it's id matches with the Id of assignment creator.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment that is created by the '''TA'''.
# If Logged in as '''Instructor''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option if they '''did not create that assignment'''.

Automated Testing

The issue as such did not require modifying the controller spec file for assignments, since the changes were only made to the delete function and the test cases written check for the display of proper flash message that could be mapped for the modified code functionality. Only '''manual testing''' was performed to determine '''successful deletion''' by '''instructor'''.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Implementation===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would reuse the existing automation tests.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Implementation===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>
<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Implementation===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

The following test was added to '''assignment_form_spec.rb''' to test if there is an error if the sum of weights of the rubrics do not add up to 0 or 100.

<pre>
context 'when both save and update_attributes method do not work with wrong rubrics weights' do
it 'changes @has_errors value to true and returns nil' do
allow(assignment_questionnaire).to receive(:save).and_return(true)
allow(assignment_questionnaire2).to receive(:update_attributes).with(assignment_questionnaire2).and_return(true)
allow(assignment_questionnaire2).to receive(:[]).with(:questionnaire_weight).and_return(12)
expect(assignment_form.update_assignment_questionnaires(attributes)).to eq(nil)
expect(assignment_form.instance_variable_get(:@has_errors)).to be true
end
end
</pre>

===References===

1. [https://www.youtube.com/watch?v=3RKdJe1lxS0 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-10T04:38:06Z

Zmathew: /* Proposed Solution */

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would reuse the existing automation tests.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>
<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

The following test was added to '''assignment_form_spec.rb''' to test if there is an error if the sum of weights of the rubrics do not add up to 0 or 100.

<pre>
context 'when both save and update_attributes method do not work with wrong rubrics weights' do
it 'changes @has_errors value to true and returns nil' do
allow(assignment_questionnaire).to receive(:save).and_return(true)
allow(assignment_questionnaire2).to receive(:update_attributes).with(assignment_questionnaire2).and_return(true)
allow(assignment_questionnaire2).to receive(:[]).with(:questionnaire_weight).and_return(12)
expect(assignment_form.update_assignment_questionnaires(attributes)).to eq(nil)
expect(assignment_form.instance_variable_get(:@has_errors)).to be true
end
end
</pre>

===References===

1. [https://www.youtube.com/watch?v=3RKdJe1lxS0 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-10T04:26:41Z

Zmathew: /* Test Plan */

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would reuse the existing automation tests.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list

</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

The following test was added to '''assignment_form_spec.rb''' to test if there is an error if the sum of weights of the rubrics do not add up to 0 or 100.

<pre>
context 'when both save and update_attributes method do not work with wrong rubrics weights' do
it 'changes @has_errors value to true and returns nil' do
allow(assignment_questionnaire).to receive(:save).and_return(true)
allow(assignment_questionnaire2).to receive(:update_attributes).with(assignment_questionnaire2).and_return(true)
allow(assignment_questionnaire2).to receive(:[]).with(:questionnaire_weight).and_return(12)
expect(assignment_form.update_assignment_questionnaires(attributes)).to eq(nil)
expect(assignment_form.instance_variable_get(:@has_errors)).to be true
end
end
</pre>

===References===

1. [https://www.youtube.com/watch?v=3RKdJe1lxS0 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-10T04:23:17Z

Zmathew: /* Issue #1065 - Issue related to rubrics when an assignment is copied */

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would reuse the existing automation tests.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list

</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

1. [https://www.youtube.com/watch?v=3RKdJe1lxS0 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-10T04:21:40Z

Zmathew: /* Issue #308 - Issue related to questionnaire weight */

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list

</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

1. [https://www.youtube.com/watch?v=3RKdJe1lxS0 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-10T04:21:19Z

Zmathew: /* Issue #1065 - Issue related to rubrics when an assignment is copied */

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignments are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

No automated test cases, only manual testing since the modifications are made to the view files.

===References===

1. [https://youtu.be/G9rWkcBSPnU Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1320 Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

1. [https://www.youtube.com/watch?v=-3PTZjRLN-o&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

1. [https://www.youtube.com/watch?v=io89e3xlRPA Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="" class="table table-striped" style="font-size: 15px">

</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>

<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list

</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

1. [https://www.youtube.com/watch?v=5LImhZ3F_RA&t=2s Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1323 Pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

1. [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Demo Video Link]

2. [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-07T22:29:09Z

Zmathew:

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignemtns are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? && (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date''' at the bottom.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if @user.role.name == "Instructor" or (@user.role.name == "Teaching Assistant" and id == @assignment_form.assignment.instructor_id)
# allow delete
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1324 Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

The issue was not with the instructor been not able to get added as the participant but it was that the list was not getting updated after adding the participant and that was due to inconsistent referencing in the view and javascript file. the inconsistent version of both the file is shown as below

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#plist").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>
<div class = "">

<table id="" class="table table-striped" style="font-size: 15px">
<tr>
<th colspan=5 style="background-color: white; border-top: 0px"></th>
<th colspan=3 >E-mail on ...</th>
<th colspan=3 >Permissions ...</th>
</tr>
<tr>
<th class="head">Name</th>
<th class="head">Full Name</th>
<th class="head">Email Address</th>
<th class="head">Role</th>
<th class="head">Parent</th>
<% if params[:model] == 'Assignment' and Assignment.find_by(id: params[:id]).has_badge? %>
<th class="head">Badges</th>
<% end %>
<th class="head">Review</th>
<th class="head">Submission</th>
<th class="head">Metareview</th>
<th class="head">Submit</th>
<th class="head">Review</th>
<th class="head">Take quiz</th>
<th class="head">Handle</th>
<th class="head">Action</th>
</tr>

<% @user_id = [] %>
<%= render partial: 'participants/participant', collection: user_list, :locals => {:userid => @user_id, :controller => 'participants'}%>

</table>

</div>

<script>
var participants = <%=@user_id%>;
participants.forEach(function(participant){
$('#'.concat(participant.toString())).change(function(){
$('#button'.concat(participant.toString())).show();
});
});
</script>
</pre>

The changed versions are as follows:

 add.js.erb file
<pre>
<% unless flash[:error] %>
$("#user_list").append(
"<%= j render :partial => 'participant', :locals => {participant: @participant, :userid => @participant.user_id, :controller => 'participants'} %>");
<% end %>
+$("#flash_message").html("<%= j render partial: "shared/flash_messages" %>");
</pre>

 _user_list.html.erb file

<pre>
<div class = "">

<table id="user_list" class="table table-striped" style="font-size: 15px"> # here the table id is changed to user_list
<tr>
<th colspan=5 style="background-color: white; border-top: 0px"></th>
<th colspan=3 >E-mail on ...</th>
<th colspan=3 >Permissions ...</th>
</tr>
<tr>
<th class="head">Name</th>
<th class="head">Full Name</th>
<th class="head">Email Address</th>
<th class="head">Role</th>
<th class="head">Parent</th>
<% if params[:model] == 'Assignment' and Assignment.find_by(id: params[:id]).has_badge? %>
<th class="head">Badges</th>
<% end %>
<th class="head">Review</th>
<th class="head">Submission</th>
<th class="head">Metareview</th>
<th class="head">Submit</th>
<th class="head">Review</th>
<th class="head">Take quiz</th>
<th class="head">Handle</th>
<th class="head">Action</th>
</tr>

<% @user_id = [] %>
<%= render partial: 'participants/participant', collection: user_list, :locals => {:userid => @user_id, :controller => 'participants'}%>

</table>

</div>

<script>
var participants = <%=@user_id%>;
participants.forEach(function(participant){
$('#'.concat(participant.toString())).change(function(){
$('#button'.concat(participant.toString())).show();
});
});
</script>
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1323 pull request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [https://github.com/expertiza/expertiza/pull/1328 Pull Request]

E1863 Issues related to assignment creation

2018-12-07T08:33:55Z

Zmathew: Layout change

== Introduction ==

Assignment creation can be done in Expertiza by an instructor or a TA for a particular course. It is available from the '''Manage -> Assignments''' drop down on the expertiza site. Two types of assignments can be created - private and public. The various properties of assignemtns are grouped into tabs - General, Topics, Rubrics, Review strategy, Due dates and Other stuff. There were various issues related to saving data in these. The main motive behind this project is to fix these issues and maintain data integrity.

There are 5 issues that are being dealt with in this project and each of them are explained in detail below.

==Issue #1008 - Issue related to staggered deadline==

===Problem Statement===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Proposed Solution===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Test Plan===

Manual Testing

# Log in to Expertiza with the credentials: instructor6/password (on google chrome)
# Go to the '''Manage''' -> '''Assignments'''.
# Click on '''New Public Assignment'''
# On the new assignment creation page, under the '''General''' tab, give details for '''Assignment name''', '''Course''' (choose CSC 517, Spring 2016) and '''Submission directory'''.
# Check the '''Staggered deadline assignment?''' checkbox.
# Click on the '''Rubrics''' tab and give some values for '''Review''' and '''Author Feedback''', if there are any other fields apart from these give values to that too.
# Click on '''Create''' at the bottom.
# Now, click on the the '''Topics''' tab and further click on '''New Topic'''.
# Give suitable values to the fields and click on '''Create'''.
# Click on the '''Due dates''' tab.
# Check the '''Use signup deadline''' checkbox and give suitable dates for '''Signup''', '''Round1: Submission''' and '''Round1: Review'''.
# Go back to the '''Topics''' tab and click on '''Show start/due date at the bottom'''.
# Change the '''Submission deadline''' date to date later than the date given for '''Signup''' on the '''Due dates''' tab.
# Click on '''save''' at the bottom.
# Now, click on the '''Other stuff''' tab and and further click on '''Add participant'''. It will open in a new tab.
# Click on '''Copy participants from course'''. After it adds the participants, close the tab.
# Go to '''Manage''' -> '''Impersonate User'''.
# Give '''student6360''' for the '''Enter user account''' field and click on '''Impersonate'''.
# Click on '''Assignments''' and further click on the assignment that was created in the earlier steps.
# Click on Signup Sheet.
# You should be able to see a '''green tick mark''' under the Actions header and '''should be able to click on it''' and signup, which means the issue is fixed.

Automated Testing

Test cases would involve setting the topic submission deadline to a date later than the the signup deadline testing the view actions.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1017 - Issue related to deleting assignment==

===Problem Statement===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA. When an assignment is created by the instructor or by the TA , the delete option is assigned to self, that is, to the one who created the assignment. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Proposed Solution===

The flow diagram given below specifies the sequence of events that will aim at resolving the issue related to deleting an assignment :

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Test Plan===

Manual Testing

''Task Description:'' Teaching Assistant creating an assignment

''Precondition:'' The instructor has set up the page for assignment creation.

''Primary Flow:''

# Log in to Expertiza
# Select '''New Assignment'''
# Enter the '''Assignment Name''' and select '''Course'''.
# Check the parameters for the teams, quiz, badges categories etc.
# Click '''Create'''

''Task Description:'' Instructor or Teaching Assistant deleting an assignment

''Precondition:'' There exists at least one assignment created by TA.

''Primary Flow:''

# Log in to Expertiza
# Select the '''Delete''' option in the action section for an assignment created by the '''TA'''.
# If Logged in as '''Instructor or Teaching Assistant''', the assignment gets deleted for that action.
# Else, the '''current participant''' is shown the '''error''' message that they do not have authorization to execute the delete option.

Automated Testing

Test cases mainly involve controller testing to check the '''assignment created by TA''' and it '''can be deleted by instructor''' through invocation of the '''''delete''''' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1065 - Issue related to rubrics when an assignment is copied==

===Problem Statement===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Proposed Solution===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #1072 - Issue related to instructor's assignment participation==

===Problem Statement===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Proposed Solution===

When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issues1072.png]]

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Create a new Assignment
# Click on the add participant button for the assignment created
# Modify the participant list by adding instructor as a participant
# Check the list to see the instructor added to the assignment as participant

Automated Testing

This would involve the controller and view testing to see if the instructor is added to the assignment as a participant through the add and list methods that are being invoked with the participant list showing instructor as the participant.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

==Issue #308 - Issue related to questionnaire weight==

===Problem Statement===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

===Proposed Solution===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

===Test Plan===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

===References===

# [https://piazza.com/class/jl1cgvwxl0f1nl?cid=539 Video Link]

# [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Pull Request]

E1863 Issues related to assignment creation

2018-11-20T22:10:32Z

Zmathew:

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

Log in as a Instructor. When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issue1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

Manual Testing

Automated Testing

===Issue #1017 - Issue related to deleting assignment===

Manual Testing

Automated Testing

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

Manual Testing

Automated Testing

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

E1863 Issues related to assignment creation

2018-11-20T22:07:25Z

Zmathew: Added Test Plan

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem Statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

Log in as a Instructor. When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issue1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

== Test Plan ==

Following are the test plans for the individual issues:

===Issue #1008 - Issue related to staggered deadline===

===Issue #1017 - Issue related to deleting assignment===

===Issue #1065 - Issue related to rubrics when an assignment is copied===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab to see if there are multiple rubrics defined
# Copy the assignment, if there are multiple rubrics, from the assignments listing screen
# Access the newly copied assignment
# Check if the rubrics tab lists down rubrics for all rounds in the original assignment

Automated Testing

This would mainly involve controller testing to see if the rubrics are copied entirely after the invocation of the ''copy_assignment_questionnaire'' method.

===Issue #1072 - Issue related to instructor's assignment participation===

===Issue #308 - Issue related to questionnaire weight===

Manual Testing

# Log into Expertiza as instructor
# Access the Assignments listing
# Access an assignment and go to the 'Rubrics' tab
# Modify the data in the rubric weights column in such a way that it adds up to a value other than 0 or 100
# Click save
# Check to see if there is an error thrown and the rubrics tab is not saved

Automated Testing

This would mainly involve controller testing to see if the notice is set correctly when the ''update_assignment_questionnaires'' method is invoked with the sum of weights not being 0 or 100.

E1863 Issues related to assignment creation

2018-11-20T21:21:39Z

Zmathew: /* Issue #308 - Issue related to questionnaire weight */

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

Log in as a Instructor. When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issue1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
 total_weight=0
 attributes.each do |assignment_questionnaire|
 total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
 end
 if total_weight != 0 and total_weight != 100
 @assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
 @has_errors = true
 end
end
</pre>

E1863 Issues related to assignment creation

2018-11-20T21:18:04Z

Zmathew: /* Issue #1065 - Issue related to rubrics when an assignment is copied */

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

This can be understood through the flow diagram provided below:

[[File:Issue1017.png]]

The fix to resolve the issue involves the delete function in the assignment controller. The code at present checks for the current user and allows it the permission to delete the file.

if id != @assignment_form.assignment.instructor_id
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
else
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
end

To allow instructor to delete an assignment created by TA, the if-else block is fixed as given:

if id == @assignment_form.assignment.instructor_id or (@user.role == "Instructor" and @assignment_form.assignment.instructor.name.role == "ta")
# allow instructor to delete assignment
@assignment_form.delete(params[:force])
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "Assignment #{@assignment_form.assignment.id} was deleted.", request)
flash[:success] = "The assignment was successfully deleted."
else
# throw error
ExpertizaLogger.info LoggerMessage.new(controller_name, session[:user].name, "You are not authorized to delete this assignment.", request)
raise "You are not authorized to delete this assignment."
end

Modifications made to the code check for the form id and allow permission to delete when the id belongs to assignment creator or when the role of the current user is 'Instructor'.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

Log in as a Instructor. When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issue1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
total_weight=0
attributes.each do |assignment_questionnaire|
total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
end
if total_weight != 0 and total_weight != 100
@assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
@has_errors = true
end
end
</pre>

E1863 Issues related to assignment creation

2018-11-14T06:51:03Z

Zmathew: /* Issue #308 - Issue related to questionnaire weight */

== Introduction ==

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

== Problem statement ==

There are 5 issues that are being dealt with in this project:

===Issue #1008 - Issue related to staggered deadline===

If there are multiple topics added in an staggered-deadlined assignment and if the deadline of those topics are in future, students are not able to sign up for any of them. Overall assignment due dates are taking precedence, on the Due Dates tab. Due dates for the assignment needs to be changed manually to the due dates for the new topics just added. Students are able to sign up for topics only when all of the assignment due dates are in the future AND the due date for the topic they are choosing is in the future. They should be able to sign up if only the due date for the topic they are choosing is in the future. The overall assignment due dates should be irrelevant. In other words, topic should obey just the topic deadlines and not the assignment deadlines.

===Issue #1017 - Issue related to deleting assignment===

At present, when the TA creates a new assignment, only he has the ability to delete it. The task at hand is to allow the instructor to delete the assignment that is created by a TA.

When an assignment is created by a participant, it assigns the delete option to self. This needs to be overridden in that the instructor must be able to view the assignment list by having an additional parameter to classify the creator of that assignment as Teaching Assistant or Instructor, and giving the Instructor the option to delete an assignment created by TA.

===Issue #1065 - Issue related to rubrics when an assignment is copied===

There are assignments that have rubrics that vary by round, i.e. each round of the assignment review will have a different set of rubrics. When such an assignment is copied, there exists a problem where the rubrics from the original assignment are not copied over properly to the new assignment. This new assignment does not have rubrics that vary by round, as in the original assignment, but have the rubric from Round 1 in the original assignment copied over for all rounds. This makes the copying of assignments incomplete and thus, needs to be fixed.

===Issue #1072 - Issue related to instructor's assignment participation===

The Issue is that the Instructor is not able to participate in a given assignment. This issues require a fix so that the instructor can also add himself as a participant in the assignment created .This fix will allow the instructor to perform the same functionality as the other student participants as reviewing peer assignments , submitting assignment, etc.

===Issue #308 - Issue related to questionnaire weight===

While creating/editing an assignment, one of the configurations is setting up of the rubrics. This is done in the 'Rubrics' tab of the assignment page. While setting up the rubrics, we can assign a weight to each of it, so that the final score will be the weighted sum of the different rubric scores. The default weight of a rubric is always 0%, meaning that it's not counted towards the final score. But if any of the rubric is assigned with a non-zero weight, we need to make sure that the sum of all the weights of the various rubrics add up to 100%. This is not enforced currently, allowing the user to have a total weight which is between 0% and 100%. This needs to be fixed to bring in a hard stop, if the sum of the weights don't add up to 0% or 100%.

== Proposed Solution ==

===Issue #1008 - Issue related to staggered deadline===

For staggered deadline assignments, different topics might have different deadlines. So, the deadline for each topic needs to be checked on an individual basis. Deadlines for individual topics are stored in a table called '''due_dates''' with the '''parent_id''' as the identifier of the particular topic in place of the assignment identifier. A logic for getting the due dates of individual topics for staggered deadline assignments is found in the method '''check_topic_due_date_value''' in the module '''SignUpSheetHelper'''.

<pre>
topic_due_date = TopicDueDate.where(parent_id: topic_id, deadline_type_id: deadline_type_id, round:review_round).first rescue nil
if !topic_due_date.nil?
due_date = topic_due_date.due_at
else
due_date = assignment_due_dates[review_round - 1].due_at.to_s
</pre>

Currently, if the signup deadline of the the '''assignment''' is earlier that the '''submission deadline for a topic''', that topic is not available for taking. This is restricted by the following piece of code in '''_all_actions.html.erb'''.

<pre>
<% elsif (@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id))) %>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

Fix to be implemented(tentative):
Change the above piece of code to allow signing up staggered assignment topics bases on the topic deadline and not on the assignment sign up deadline. The prospective change is shown below.

<pre>
<% elsif ((@signup_topic_deadline.nil? || (Time.now < @signup_topic_deadline.due_at)) &&
(!@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))) ||
(@assignment.staggered_deadline? || (Time.now < get_topic_deadline([@assignment.due_dates.find_by(deadline_type_id: 1)], topic.id)))%>
<td align="center"><%= link_to image_tag('Check-icon.png', :border => 0, :title => 'Signup', :align => 'middle'), :controller=>'sign_up_sheet', :action=> 'sign_up',
:id=>params[:id],:topic_id => topic.id, :assignment_id => params[:assignment_id] %></td>
<% end %>
</pre>

===Issue #1017 - Issue related to deleting assignment===

'''Task Description:''' Teaching Assistant creating an assignment

'''Precondition:''' Has the instructor set up the page for assignment creation.

'''Primary Flow:'''

# Log in to Expertiza
# Select New Assignment
# Enter the Assignment Name and select Course.
# Check the parameters for the teams, quiz, badges categories etc.
# Click Create

'''Task Description:''' Instructor or Teaching Assistant deleting an assignment

'''Precondition:''' There exists at least one assignment created by TA.

'''Primary Flow:'''

# Log in to Expertiza
# Select the Delete option in the action section for an assignment created by the TA.
# If Logged in as Instructor or Teaching Assistant, the assignment gets deleted for that action.
# Else, the current participant cannot execute the option.

[[File:Issue1017.png]]

===Issue #1065 - Issue related to rubrics when an assignment is copied===

When an assignment is copied, all the rubric data is to be copied over. As the copying over was incomplete, there were issues. This is fixed in the '''copy_assignment_questionnaire''' method of '''assignment_form.rb''' file.

[[File:Issue1065flowchart.png]]

The current code is shown below. We can see that the data (columns) related to the various rounds are not copied over. This needs to be fixed.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight
)
end
end
</pre>

After the fix, the code looks like below. The columns related to the various rounds will be copied over from now on.

<pre>
def self.copy_assignment_questionnaire(old_assign, new_assign, user)
old_assign.assignment_questionnaires.each do |aq|
AssignmentQuestionnaire.create(
assignment_id: new_assign.id,
questionnaire_id: aq.questionnaire_id,
user_id: user.id,
notification_limit: aq.notification_limit,
questionnaire_weight: aq.questionnaire_weight,
used_in_round: aq.used_in_round,
dropdown: aq.dropdown
)
end
end
</pre>

===Issue #1072 - Issue related to instructor's assignment participation===

Log in as a Instructor. When the instructor is logged in he can create a new assignment or use an existing assignment . All the assignments that are created would require participants which happens to be the responsibility of the instructor . Thus the Instructor adds the participants to the assignment and with this fix the instructor will be added as a participant by default every time a new assignment is created.The new functionality in the assignment controller will be modified to resolve the issue.

[[File:Issue1072.png]]

===Issue #308 - Issue related to questionnaire weight===

When we save a new/existing assignment, we need to bring in a check to see if the sum of the weights of the various rubrics add up to 0 or 100%. If this check fails, we need to throw a notice that says, "Sum of weights of rubrics need to be 0 or 100%.". The user has to make the corresponding modification to the weights and try again. If the check succeeds, we continue with the assignment saving process.

[[File:Issue308Flowchart.png]]

A new validation method '''validate_assignment_questionnaires_weights''' called in the '''update_assignment_questionnaires''' method of '''assignment_form.rb''' would do the checking:

<pre>
# code to save assignment questionnaires
def update_assignment_questionnaires(attributes)
return false unless attributes
validate_assignment_questionnaires_weights(attributes)
@errors = @assignment.errors
unless @has_errors
existing_aqs = AssignmentQuestionnaire.where(assignment_id: @assignment.id)
existing_aqs.each(&:delete)
attributes.each do |assignment_questionnaire|
if assignment_questionnaire[:id].nil? or assignment_questionnaire[:id].blank?
aq = AssignmentQuestionnaire.new(assignment_questionnaire)
unless aq.save
@errors = @assignment.errors.to_s
@has_errors = true
end
else
aq = AssignmentQuestionnaire.find(assignment_questionnaire[:id])
unless aq.update_attributes(assignment_questionnaire)
@errors = @assignment.errors.to_s
@has_errors = true
end
end
end
end
end

# checks to see if the sum of weights of all rubrics add up to either 0 or 100%
def validate_assignment_questionnaires_weights(attributes)
total_weight=0
attributes.each do |assignment_questionnaire|
total_weight+=assignment_questionnaire[:questionnaire_weight].to_i
end
if total_weight != 0 and total_weight != 100
@assignment.errors.add(:message,'Total weight of rubrics should add up to either 0 or 100%')
@has_errors = true
end
end
</pre>

E1863 Issues related to assignment creation

2018-11-14T05:03:41Z

Zmathew: /* Issue #308 - Issue related to questionnaire weight */

E1863 Issues related to assignment creation

2018-11-14T04:58:50Z

Zmathew: /* Issue #308 - Issue related to questionnaire weight */

E1863 Issues related to assignment creation

2018-11-14T04:55:55Z

Zmathew: /* Issue #1017 - Issue related to deleting assignment */

E1863 Issues related to assignment creation

2018-11-14T04:55:08Z

Zmathew: /* Issue #1017 - Issue related to deleting assignment */

E1863 Issues related to assignment creation

2018-11-14T04:50:43Z

Zmathew: /* Issue #1065 - Issue related to rubrics when an assignment is copied */

E1863 Issues related to assignment creation

2018-11-13T05:53:22Z

Zmathew: /* Issue #308 - Issue related to questionnaire weight */

E1863 Issues related to assignment creation

2018-11-13T05:37:22Z

Zmathew: Proposed Solution

File:Issue1065flowchart.png

2018-11-13T05:36:43Z

Zmathew:

File:Issue308Flowchart.png

2018-11-13T05:31:29Z

Zmathew: uploaded a new version of "File:Issue308Flowchart.png"

File:Issue308Flowchart.png

2018-11-13T05:25:59Z

Zmathew:

E1863 Issues related to assignment creation

2018-11-13T02:34:43Z

Zmathew: /* Issue #308 - Issue related to questionnaire weight */

E1863 Issues related to assignment creation

2018-11-13T01:38:42Z

Zmathew: /* Issue #1065 - Issue related to rubrics when an assignment is copied */

E1863 Issues related to assignment creation

2018-11-13T01:34:21Z

Zmathew: /* Issue #1065 - Issue related to rubrics when an assignment is copied */

E1863 Issues related to assignment creation

2018-11-13T01:26:04Z

Zmathew:

E1863 Issues related to assignment creation

2018-11-13T01:25:35Z

Zmathew:

E1863 Issues related to assignment creation

2018-11-13T01:17:44Z

Zmathew: Created page with "== Introduction == === Background === An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignm..."

== Introduction ==
=== Background ===

An instructor or TA can create assignments within a course. There are a lot of configurations that can be made while creating these assignments and there are a few known issues related to this.

=== Problem statement ===

There are 5 issues that are being dealt with in this project:

'''1. Issue #1008 - Issue related to staggered deadline'''

'''2. Issue #1017 - Issue related to deleting assignment'''

'''3. Issue #1065 - Issue related to rubrics when an assignment is copied'''

'''4. Issue #1072 - Issue related to instructor's assignment participation'''

'''5. Issue #308 - Issue related to questionnaire weight'''

E1826 Add student view for instructor

2018-11-10T03:56:08Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view of the user and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>

=== expertiza/app/controllers/role_switch_controller.rb ===

A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
<pre>
class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
['Super-Administrator',
'Administrator',
'Teaching Assistant',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = Role.find(session[:user].role_id)
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

=== expertiza/config/role_[admin|super_admin|instructor].yml ===

A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin , teaching assistants and instructor.
<pre>
73: &25 !ruby/object:Menu::Node
content_page_id:
controller_action_id: 15
id: 73
label: Student View
name: student_view
parent:
parent_id: 37
site_controller_id: 35
url: "/role_switch/open_student_view"
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==

The following lines are added to '''spec/features/student_view_spec.rb''' file.

1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent and 'Open Student View' link is present when an instructor is in default view. Also on clicking the 'Manage...' button the 'Student View' sub-menu item should be listed.

<pre>
it "can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
create(:role_of_student)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Open Student View')
expect(page).not_to have_content('Assignments')
click_button "Manage..."
expect(page).to have_content('Student View')
end
</pre>

2. '''Check whether ''Assignments'' is present in the menu in default view and there is an option to ''Close Student View'''''
This test case is to check if the menu item ''Assignments'' and link ''Close Student View'' are present when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
create(:role_of_student)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Open Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Close Student View')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-30T05:45:23Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view of the user and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>

=== expertiza/app/controllers/role_switch_controller.rb ===

A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
<pre>
class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
['Super-Administrator',
'Administrator',
'Teaching Assistant',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = Role.find(session[:user].role_id)
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

=== expertiza/config/role_[admin|super_admin|instructor].yml ===

A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin , teaching assistants and instructor.
<pre>
73: &25 !ruby/object:Menu::Node
content_page_id:
controller_action_id: 15
id: 73
label: Student View
name: student_view
parent:
parent_id: 37
site_controller_id: 35
url: "/role_switch/open_student_view"
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==

The following lines are added to '''spec/features/student_view_spec.rb''' file.

1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent and 'Open Student View' link is present when an instructor is in default view. Also on clicking the 'Manage...' button the 'Student View' sub-menu item should be listed.

<pre>
it "can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Open Student View')
expect(page).not_to have_content('Assignments')
click_button "Manage..."
expect(page).to have_content('Student View')
end
</pre>

2. '''Check whether ''Assignments'' is present in the menu in default view and there is an option to ''Close Student View'''''
This test case is to check if the menu item ''Assignments'' and link ''Close Student View'' are present when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Open Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Close Student View')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-30T05:37:31Z

Zmathew: /* expertiza/config/role_[admin|super_admin|instructor].yml */

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view of the user and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>

class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
['Super-Administrator',
'Administrator',
'Teaching Assistant',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = Role.find(session[:user].role_id)
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

=== expertiza/config/role_[admin|super_admin|instructor].yml ===

A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin , teaching assistants and instructor.
<pre>
73: &25 !ruby/object:Menu::Node
content_page_id:
controller_action_id: 15
id: 73
label: Student View
name: student_view
parent:
parent_id: 37
site_controller_id: 35
url: "/role_switch/open_student_view"
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==

The following lines are added to '''spec/features/student_view_spec.rb''' file.

1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent and 'Open Student View' link is present when an instructor is in default view. Also on clicking the 'Manage...' button the 'Student View' sub-menu item should be listed.

<pre>
it "can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Open Student View')
expect(page).not_to have_content('Assignments')
click_button "Manage..."
expect(page).to have_content('Student View')
end
</pre>

2. '''Check whether ''Assignments'' is present in the menu in default view and there is an option to ''Close Student View'''''
This test case is to check if the menu item ''Assignments'' and link ''Close Student View'' are present when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Open Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Close Student View')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-30T05:34:03Z

Zmathew: /* expertiza/app/controllers/role_switch_controller.rb */

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view of the user and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>

class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
['Super-Administrator',
'Administrator',
'Teaching Assistant',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = Role.find(session[:user].role_id)
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

=== expertiza/config/role_[admin|super_admin|instructor].yml ===

A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin and instructor.
<pre>
73: &25 !ruby/object:Menu::Node
content_page_id:
controller_action_id: 15
id: 73
label: Student View
name: student_view
parent:
parent_id: 37
site_controller_id: 35
url: "/role_switch/open_student_view"
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==

The following lines are added to '''spec/features/student_view_spec.rb''' file.

1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent and 'Open Student View' link is present when an instructor is in default view. Also on clicking the 'Manage...' button the 'Student View' sub-menu item should be listed.

<pre>
it "can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Open Student View')
expect(page).not_to have_content('Assignments')
click_button "Manage..."
expect(page).to have_content('Student View')
end
</pre>

2. '''Check whether ''Assignments'' is present in the menu in default view and there is an option to ''Close Student View'''''
This test case is to check if the menu item ''Assignments'' and link ''Close Student View'' are present when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Open Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Close Student View')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-30T05:33:22Z

Zmathew: /* expertiza/app/views/shared/_navigation.html.erb */

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view of the user and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>

=== expertiza/app/controllers/role_switch_controller.rb ===

A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
<pre>
class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# instructor,admin,superadmin is allowed to perform all the actions in
# this controller
['Super-Administrator',
'Administrator',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = session[:user].role
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

=== expertiza/config/role_[admin|super_admin|instructor].yml ===

A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin and instructor.
<pre>
73: &25 !ruby/object:Menu::Node
content_page_id:
controller_action_id: 15
id: 73
label: Student View
name: student_view
parent:
parent_id: 37
site_controller_id: 35
url: "/role_switch/open_student_view"
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==

The following lines are added to '''spec/features/student_view_spec.rb''' file.

1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent and 'Open Student View' link is present when an instructor is in default view. Also on clicking the 'Manage...' button the 'Student View' sub-menu item should be listed.

<pre>
it "can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Open Student View')
expect(page).not_to have_content('Assignments')
click_button "Manage..."
expect(page).to have_content('Student View')
end
</pre>

2. '''Check whether ''Assignments'' is present in the menu in default view and there is an option to ''Close Student View'''''
This test case is to check if the menu item ''Assignments'' and link ''Close Student View'' are present when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Open Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Close Student View')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-28T22:31:29Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? and !session[:user].role.ta? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>
=== expertiza/app/controllers/role_switch_controller.rb ===

A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
<pre>
class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# instructor,admin,superadmin is allowed to perform all the actions in
# this controller
['Super-Administrator',
'Administrator',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = session[:user].role
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

=== expertiza/config/role_[admin|super_admin|instructor].yml ===

A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin and instructor.
<pre>
73: &25 !ruby/object:Menu::Node
content_page_id:
controller_action_id: 15
id: 73
label: Student View
name: student_view
parent:
parent_id: 37
site_controller_id: 35
url: "/role_switch/open_student_view"
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==

The following lines are added to '''spec/features/student_view_spec.rb''' file.

1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent and 'Open Student View' link is present when an instructor is in default view. Also on clicking the 'Manage...' button the 'Student View' sub-menu item should be listed.

<pre>
it "can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Open Student View')
expect(page).not_to have_content('Assignments')
click_button "Manage..."
expect(page).to have_content('Student View')
end
</pre>

2. '''Check whether ''Assignments'' is present in the menu in default view and there is an option to ''Close Student View'''''
This test case is to check if the menu item ''Assignments'' and link ''Close Student View'' are present when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Open Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Close Student View')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-28T21:57:13Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? and !session[:user].role.ta? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>
=== expertiza/app/controllers/role_switch_controller.rb ===

A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
<pre>
class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# instructor,admin,superadmin is allowed to perform all the actions in
# this controller
['Super-Administrator',
'Administrator',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = session[:user].role
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

=== expertiza/config/role_[admin|super_admin|instructor].yml ===

A new menu node with the below format is added under 'Manage...' node in the yml configuration files for admin, superadmin and instructor.
<pre>
73: &25 !ruby/object:Menu::Node
content_page_id:
controller_action_id: 15
id: 73
label: Student View
name: student_view
parent:
parent_id: 37
site_controller_id: 35
url: "/role_switch/open_student_view"
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent when an instructor is in default view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Swtich to Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-28T21:50:45Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements on the navigation bar including the menu items.

In order to switch between default view and student view, the following code was added. When in default view, the instructor is presented with a link, ''Open Student View'', to switch to student view and when in student view, the ''Close Student View'' link can be used to switch back to the default view.
<pre>
<% if session[:user] and !session[:user].role.student? and !session[:user].role.ta? %>
<% if session.key?(:student_view) %>
<%= link_to "Close Student View", {controller: "role_switch", action: "close_student_view"}, method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Open Student View", {controller: "role_switch", action: "open_student_view"}, method: :post, :style => "color: white" %>
<% end %>
<% end %>
</pre>
=== expertiza/app/controllers/role_switch_controller.rb ===

A new ''role_switch_controller.rb'' file has been added. This controller contains the actions to open/close student view.
<pre>
class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# instructor,admin,superadmin is allowed to perform all the actions in
# this controller
['Super-Administrator',
'Administrator',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = session[:user].role
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

== Manual UI Testing ==

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' is absent in the menu in default view and there is an option to ''Open Student View'''''
This test case is to check if the menu item ''Assignments'' is absent when an instructor is in default view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Swtich to Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-28T21:14:37Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/controllers/instructor_controller.rb ===

A new role_switch_controller.rb file has been added. This controller contains the actions to open/close student view.
<pre>
class RoleSwitchController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# instructor,admin,superadmin is allowed to perform all the actions in
# this controller
['Super-Administrator',
'Administrator',
'Instructor'].include? current_role_name
end

# sets student_view in session object and redirects to
# student_task/list after updating menu list
def open_student_view
session[:student_view] = true
role = Role.student
session[:menu] = role.cache[:menu]
redirect_to controller: 'student_task', action: 'list'
end

# closes student_view in session object and redirects to
# tree_display/list after reverting the menu list as per the role
def close_student_view
session.delete(:student_view)
role = session[:user].role
session[:menu] = role.cache[:menu]
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the role switch controller's ''open_student_view'' and ''close_student_view'' actions.

<pre>
resources :role_switch, only: [] do
collection do
post :open_student_view
post :close_student_view
end
end
</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Swtich to Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/hrshagrwl/expertiza]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-28T21:01:16Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Login as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Open Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Close Student View''' below username to come back to default view.

[[File:student_view.png]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Swtich to Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

File:Student view.png

2018-10-28T20:56:00Z

Zmathew: uploaded a new version of "File:Student view.png"

File:Default view.png

2018-10-28T20:54:41Z

Zmathew: uploaded a new version of "File:Default view.png"

E1826 Add student view for instructor

2018-10-28T20:37:47Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:default_view.png]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:new_student_view.png]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Swtich to Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

File:New student view.png

2018-10-28T20:36:57Z

Zmathew:

File:Default view.png

2018-10-28T20:35:37Z

Zmathew:

E1826 Add student view for instructor

2018-10-28T20:32:27Z

Zmathew:

== Introduction ==
=== Background ===

The navigation for an instructor follows the below structure.
* Home
* Manage...
** Users
** Questionnaires
** Courses
** ''Assignments''
** Impersonate User
** Anonymized View
* Survey Deployments
* ''Assignments''
* Course Evaluation
* Profile
* Contact Us

And that for a student follows the below structure.
* Home
* Assignments
* Pending Surveys
* Profile
* Contact Us

For an instructor, the menu item 'Assignments' is present in 2 places - in the main menu as 'Assignments' and in the sub-menu as 'Manage.../Assignments' (''italicized'' above). This could potentially be confusing. 'Manage.../Assignments' sub-menu item allows the instructor to create/edit assignments. The menu item 'Assignments' allows an instructor to participate in assignments. This is typically something that the instructor wants to do in a student role and hence there needs to be a '''student view''' for instructors to act as students without impersonating them and thus reducing confusion. The same needs to be implemented for admin and super admin as well.

=== Problem statement ===
Create a '''student view''' for instructors so that they can perform student operations without impersonating them. When an instructor logs in, he/she is in the default view with corresponding menu items (with the exception of the 'Assignments' menu item). There should be an option to switch to and revert back from the student view. When in student view, an instructor is presented with the student menu as listed above.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Swtich to Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/

E1826 Add student view for instructor

2018-10-28T19:03:37Z

Zmathew: Created page with "== Introduction == === Background === [http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students ..."

== Introduction ==
=== Background ===
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University], Raleigh.

Currently, when an '''instructor''' logs into Expertiza, he/she sees the following menu items across the top:

''Home Manage content Survey Deployments Assignments Course Evaluation Profile Contact Us''

And, a student can see the following menu items across the top:

''Home Assignments Pending Surveys Profile Contact Us''

On the instructor’s “Manage content” menu, one of the options is “Assignments”. Having “Assignments” appear in two places is potentially confusing. “Manage content > Assignments” allows the instructor to edit and create assignments, whereas the “Assignments” menu (that both students and instructors) see allows the instructor to participate in assignments.

Therefore, it makes sense to create a '''student view''' for instructors, which will enable them to see menu items that are only related to students. This will help resolve the confusion.

=== Problem statement ===
Create a '''student view''' for instructors. When in '''student view''', an instructor must not be able to view ''"Manage content"'' and ''"Survey Deployments"'' menu items, and must be able to switch back to the '''instructor view''' (the default view that an instructor first sees when he/she logs in). When in '''instructor view''', an instructor must not be able to view the ''"Assignment"'' and ''"Course Evaluation"'' menu items.

== Implementation ==
=== expertiza/app/views/shared/_navigation.html.erb ===
This file is shared between all views and is responsible for rendering all the elements in the top-most part of the web page. (i.e Displaying the menu items, the logout button etc.)

In order to switch between '''instructor view''' and '''student view''', the following code was added. When the user is in '''instructor view''', there is a link named "Switch to Student View" to switch to '''student view''' and when the user is in '''student view''', 'here is a link named "Revert to Instructor View" to switch back to the '''instructor view'''.
<% if session[:user].role.instructor? %>
<% if session.key?(:student_view) %>
<%= link_to "Revert to Instructor View", {controller: "instructor", action: "revert_to_instructor_view"},
method: :post, :style => "color: white" %>
<% else %>
<%= link_to "Switch to Student View", {controller: "instructor", action: "set_student_view"},
method: :post, :style => "color: white" %>
<% end %>
<% end %>

=== expertiza/app/controllers/instructor_controller.rb ===

A new instructor_controller.rb file has been added. This controller currently contains the actions to switch to student view and revert back to instructor view.
<pre>
class InstructorController < ApplicationController
# check to see if the current action is allowed
def action_allowed?
# only an instructor is allowed to perform all the actions in
# this controller
return true if session[:user].role.instructor?
end

# sets student_view in session object and redirects to
# student_task/list after updating hidden_menu_items
def set_student_view
session[:student_view] = true
MenuItemsHelper.update_hidden_menu_items_for_student_view(session)
redirect_to controller: 'student_task', action: 'list'
end

# destroys student_view in session object and redirects to
# tree_display/list after updating hidden_menu_items
def revert_to_instructor_view
session.delete(:student_view)
MenuItemsHelper.update_hidden_menu_items_for_instructor_view(session)
redirect_to controller: 'tree_display', action: 'list'
end
end
</pre>

=== expertiza/config/routes.rb ===

New post methods are added in ''config/routes.rb''. The routes are directed to the instructor controller's ''set_student_view'' and ''revert_to_instructor_view'' actions.

<pre>
resources :instructor, only: [] do
collection do
post :set_student_view
post :revert_to_instructor_view
end
end

</pre>

== Manual UI Testing ==

The user needs to log-in as an instructor to view this functionality.

1. Log into Expertiza as an instructor. Enter 'instructor6' as username and 'password' as password.

2. Click on '''Switch to Student View''' below username to switch to student view.

[[File:Student_View_1.PNG]]

3. Click on '''Revert to Instructor View'''' below username to come back to instructor view.

[[File:Instructor_View_1.PNG]]

== Automated Test Plan ==
1. '''Check whether ''Assignments'' and ''Course Evaluation'' are hidden when in instructor view.'''
This test case is to check if the menu items ''Assignments'' and ''Course Evaluation'' are hidden when an instructor is in instructor view. The following lines can be added to a spec/features file:

<pre>
it " can display relevant menu items after login as an admin/instructor/TA", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
expect(page).to have_current_path('/tree_display/list')
expect(page).to have_content('Manage content')
expect(page).to have_content('Survey Deployments')
expect(page).not_to have_content('Assignments')
expect(page).not_to have_content('Course Evaluation')
end
</pre>

2. '''Check whether ''Manage content'' and ''Survey Deployments'' are hidden in student view.'''
This test case is to check if the menu items ''Manage content'' and ''Survey Deployments'' are hidden when the instructor switches to student view. The following lines are to be added:

<pre>
it "can display relevant menu items when switching to student view", js: true do
create(:instructor)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'Swtich to Student View'
expect(page).to have_current_path('/student_task/list')
expect(page).to have_content('Assignments')
expect(page).to have_content('Course Evaluation')
expect(page).not_to have_content('Manage content')
expect(page).not_to have_content('Survey Deployments')
end
</pre>

== External Links ==
# Link to forked repository [[https://github.com/akshayravichandran/expertiza]]
# Link to screen cast [[https://youtu.be/lRZT4q7YDLA]]

==References==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

RSpec Documentation
* http://rspec.info/documentation/