Expertiza_Wiki - User contributions [en]

E1859 Visualizations for Instructors

2018-12-08T05:29:01Z

Jbcolli8: /* Files Involved */

== Introduction ==
Expertiza is an online assignment grading platform. Instructors can create assignments and implement peer reviews for submitted assignments. This project concerns the creation of a system for visualizing student performance on those assignments, primarily as graded in peer reviews. Graphs will be made to show various rubric criteria and the class' performance on the criteria. If the criteria are the same for multiple stages of review, an instructor should be able to compare performance over time or between reviews.

__TOC__

== Project Purpose ==
Our task is to provide an interactive visualization or a table for instructors that shows how their class performed on selected rubric criteria. Such feature would be immensely helpful for instructors as it would assist them to identify what they need to focus more attention on. For example, creating a graph showing the average scores for all or a certain subset of main rubric criteria (questionnaire). If the average score of the class on selected criteria (question) is low means the instructor can emphasize more on the learning materials related to it.

== Proposed Changes ==
The visualizations will be implemented as either a single or stacked bar chart with a bar for each of the selected criteria to be observed. If a single bar, then the height of the bar will be the total class average, but a stacked bar chart may be better to show the percentage of the class that received each score. The changes made to the expertiza project will primarily include HTML/ERB changes to the view files to accommodate the added charts on the page and the necessary javascript to allow responsive design. Brief controller modifications will be made to facilitate database filtering to get the displayed data.

1. On clicking Manage and then on assignments, following page appears.

[[File:S1.JPG]]

2. Click on 'view score' icon of an assignment. The summary report page of the selected assignment comes up.

[[File:A0.jpg]]

3. Following are mockup screens which we wish to create:

a) Instructor would select the round and rubric criteria of the assignment for which he/she wants to view the class performance.

[[File:A1.jpg]]

b) The bar graph of the class performance for those criteria would be displayed.

[[File:Try.jpg]]

== Project Design ==

==== Design Flow ====

The flowchart representing graphical flow of an instructor visiting view scores under assignments is given below:

[[File:A3.png]]

==== Tools and Design Choice ====

We have used the lightweight [https://developers.google.com/chart/ Google Charts] library for displaying the chart data on the page, with standard HTML for all of the options and dropdowns for option selection. Google Charts was chosen because of its high compatibility, full option set, and comparable graphical quality to the rest of expertiza while keeping a small JS footprint, which should help prevent slow page responsiveness.

==== Visualization ====

The following graph shows the view of the 'view scores' page after the modifications. The instructor selects a subset of rubric criteria for which he/she wants to know how a class performed for a particular round. A bar graph of the average score of the class for that subset of criteria is displayed.

[[File:1859_Chart_Preview.png]]

The above graph shows an average score of the class for 5 rubric criteria in Round 1 selected by the instructor. A live demo with randomly generated data can be found on [https://jsfiddle.net/Jereman/5uxqr92y/ JSFiddle]

== Files Involved ==
We have implemented a new partial file criteria_charts to the team_chart that display the bar graph with existing data collected by the grades controller methods to the view page.

Modified files:
<div style="display: inline-block">
<pre>
app/controllers/grades_controller.rb

app/views/grades/_teams.html.erb

app/views/grades/_criteria_charts.html.erb

app/views/grades/_team_charts.html.erb
</pre>
</div>

=== Code ===

== app/views/grades/_criteria_charts.html.erb ==
<html>
<head>
<%= content_tag :div, class: "chartdata_information", data: {chartdata: @chartdata} do %>
<% end %>
<%= content_tag :div, class: "text_information", data: {text: @text} do %>
<% end %>
<%= content_tag :div, class: "minmax_information", data: {minmax: @minmax} do %>
<% end %>
<script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
<script type="text/javascript">
google.charts.load('current', {packages: ['corechart', 'bar']});
//Display Options
var showLabels = true;
var barColors = [ // Other colors generated from the expertiza base red
'#A90201', // using paletton.com
'#018701',
'#016565',
'#A94D01'
];
function getData(){ //Loads all chart data from the page
chartData = $('.chartdata_information').data('chartdata');
chartText = $('.text_information').data('text');
chartRange = $('.minmax_information').data('minmax');
for (var i = 0; i < chartData.length; i++){ //Set all the criteriaSelected to true
var criteria = [];
for (var j = 0; j < chartData[i].length; j++){
criteria.push(true);
}
criteriaSelected.push(criteria);
}
}
function generateData() { //Generates random data for testing
var rounds = 3;
for(var i = 0; i < rounds; i++) {
var criteriaNum = Math.floor(Math.random() * 5 + 5); //Random number of criteria
var round = [];
var criteria = [];
for(var j = 0; j < criteriaNum; j++) {
round.push(Math.floor(Math.random() * 101)); //Random score for each criterion
criteria.push(true); //Everything starts out true
}
chartData.push(round);
criteriaSelected.push(criteria);

chartOptions = { //Render options for the chart
title: 'Class Average on Criteria',
titleTextStyle: {
fontName: 'arial',
fontSize: 18,
italic: false,
bold: true
chart = new google.visualization.ColumnChart(document.getElementById('chart_div'));
var checkBox = document.getElementById("labelCheck");
checkBox.checked = true;
checkBox.style.display = "inline";
updateChart(currentRound);
loadRounds(); }
function updateChart(roundNum) { //Updates the chart with a new round number and renders
currentRound = roundNum;
renderChart();
loadCriteria();
function renderChart() { //Renders the chart if changes have been made
var data = loadData();
chartOptions.vAxis.viewWindow.max = 5;
chartOptions.vAxis.viewWindow.min = 0;
if (chartRange[currentRound]) { //Set axis ranges if they exist
if (chartRange[currentRound][1])
chartOptions.vAxis.viewWindow.max = chartRange[currentRound][1];
if (chartRange[currentRound][0])
chartOptions.vAxis.viewWindow.min = chartRange[currentRound][0];
}
chart.draw(data, chartOptions);
}

chartOptions.hAxis.ticks = [];
var rowCount = 1;
for(var i = 0; i < chartData[currentRound].length; i++) { //Add a chart row for each criterion if not null
if (criteriaSelected[currentRound][i] && chartData[currentRound][i]) {
data.addRow([rowCount, chartData[currentRound][i], barColors[0], (showLabels) ? chartData[currentRound][i].toFixed(1).toString() : ""]);
chartOptions.hAxis.ticks.push({v: rowCount++, f: (i+1).toString()});
}
}

var data = new google.visualization.DataTable();
data.addColumn('number', 'Criterion');
var i;
for(i = 0; i < roundNum; i++) { //Add all columns for the data
data.addColumn('number', 'Round ' + (i+1).toString());
data.addColumn({type: 'string', role: 'style'}); //column for specifying the bar color
data.addColumn({type: 'string', role: 'annotation'});

var newRow = [];
var elementsAdded = false;
newRow.push(rowCount);
for(var j = 0; j < roundNum; j++) { //If the round has the criterion, add it
if (chartData[j][i]) {
newRow.push(chartData[j][i]);
elementsAdded = true;
} else {
newRow.push(null);
}
newRow.push(barColors[j % barColors.length]); //Add column color
if (chartData[j] && chartData[j][i] && showLabels)
newRow.push(chartData[j][i].toFixed(1).toString()); //Add column annotations
else
newRow.push("");
}
function loadCriteria() { //Creates the criteria check boxes
var form = document.getElementById("chartCriteria");
while (form.firstChild) //Clear out the old check boxes
form.removeChild(form.firstChild);
if (currentRound == -1) //Don't show criteria for 'all rounds'
return;
chartData[currentRound].forEach(function(dat, i) {
var checkbox = document.createElement('input');
checkbox.type = "checkbox";
checkbox.id = "checkboxoption" + i;
checkbox.onclick = function() { //Register callback to toggle the criterion
checkboxUpdate(i);
}
var label = document.createElement('label')

<form id="chartOptions" name="chartOptions">
<select id="chartRounds" name="rounds"
onChange="updateChart(document.chartOptions.chartRounds.options[document.chartOptions.chartRounds.options.selectedIndex].value)" style = "display: none">
</select>
<label><input type="checkbox" id = "labelCheck" checked="checked" style="display: none" onclick="showLabels = !showLabels; renderChart();">Show
Labels</label>
</form>
<div id="chartCriteria" name="chartCriteria">
</div>

== app/controllers/grades_controller.rb ==

def action_allowed?
case params[:action]
when 'view_my_scores'
['Instructor',
'Teaching Assistant',
'Administrator',
'Super-Administrator',
'Student'].include? current_role_name and
are_needed_authorizations_present?(params[:id], "reader", "reviewer") and
check_self_review_status
when 'view_team'
if ['Student'].include? current_role_name # students can only see the head map for their own team
participant = AssignmentParticipant.find(params[:id])
session[:user].id == participant.user_id
else
true
end
else
['Instructor',
'Teaching Assistant',
'Administrator',
'Super-Administrator'].include? current_role_name
end
end
# collects the question text for display on the chart
# Added as part of E1859
def assign_chart_text
@text = []
(1..@assignment.num_review_rounds).to_a.each do |round|
question = @questions[('review' + round.to_s).to_sym]
@text[round - 1] = []
next if question.nil?
(0..(question.length - 1)).to_a.each do |q|
@text[round - 1][q] = question[q].txt
end
end
end

# find the maximum and minimum scores for each questionnaire round
# Added as part of E1859
def assign_minmax(questionnaires)
@minmax = []
questionnaires.each do |questionnaire|
next if questionnaire.symbol != :review
round = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).first.used_in_round
next if round.nil?
@minmax[round - 1] = []
@minmax[round - 1][0] = if !questionnaire.min_question_score.nil? and questionnaire.min_question_score < 0
questionnaire.min_question_score
else
0
end
@minmax[round - 1][1] = if !questionnaire.max_question_score.nil?
questionnaire.max_question_score
else
5
end
end
end
# this method collects and averages all the review scores across teams
# Added as part of E1859
def assign_chart_data
@rounds = @assignment.num_review_rounds
@chartdata = []
(1..@rounds).to_a.each do |round|
@teams = AssignmentTeam.where(parent_id: @assignment.id)
@teamids = []
@result = []
@responseids = []
@scoreviews = []
(0..(@teams.length - 1)).to_a.each do |t|
@teamids[t] = @teams[t].id
@result[t] = ResponseMap.find_by_sql ["SELECT id FROM response_maps
WHERE type = 'ReviewResponseMap' AND reviewee_id = ?", @teamids[t]]
@responseids[t] = []
@scoreviews[t] = []
(0..(@result[t].length - 1)).to_a.each do |r|
@responseids[t][r] = Response.find_by_sql ["SELECT id FROM responses
WHERE round = ? AND map_id = ?", round, @result[t][r]]
@scoreviews[t][r] = Answer.where(response_id: @responseids[t][r][0]) unless @responseids[t][r].empty?
end
end
@chartdata[round - 1] = []
# because the nth first elements could be nil
# iterate until a non-nil value is found or move to next round
t = 0
r = 0
t += 1 while @scoreviews[t].nil?
while t < @scoreviews.length and @scoreviews[t][r].nil?
if r < @scoreviews[t].length - 1
r += 1
else
def assign_chart_data
end
end
next if t >= @scoreviews.length
(0..(@scoreviews[t][r].length - 1)).to_a.each do |q|
sum = 0
counter = 0
def retrieve_questions(questionnaires)
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
@questions[questionnaire_symbol] = questionnaire.questions
end
end
def update
if format("%.2f", total_score) != params[:participant][:grade]
participant.update_attribute(:grade, params[:participant][:grade])
message = if participant.grade.nil?
"The computed score will be used for " + participant.user.name + "."
else
"A score of " + params[:participant][:grade] + "% has been saved for " + participant.user.name + "."
end
end
flash[:note] = message
redirect_to action: 'edit', id: params[:id]

== app/views/grades/_team_charts.html.erb ==
<pre>
<br> <br>
<%= render :partial => 'criteria_charts' %>
<br>

<a href="#" name='team-chartLink' onClick="toggleElement('team-chart', 'stats');return false;">Hide stats</a>
<br>
<TR style ="background-color: white;" class="team" id="team-chart">
<th>

<div class="circle" id="average-score">

</div>
Class Average
</th>
<TH COLSPAN="8">
<img src="<%= @average_chart %>" ><br>
Class Distribution
<br>
</th>
<TH WIDTH="9"> </th>
</TR>

<script type="text/javascript">
var myCircle = Circles.create({
id: 'average-score',
radius: 50,
value: <%= @avg_of_avg.to_i %>,
maxValue: 100,
width: 15,
text: '<%=@avg_of_avg.to_i%>',
colors: ['#FFEB99', '#FFCC00'],
duration: 700,
textClass: 'circles-final'
});
</script>

<style>
.circles-final{
font-size: 16px !important;
}
</style>
</pre>

== Test Plan ==
The specification of the project does not require us to use automated tests. However, we have tested the existing tests after the addition of new features to the grades_controller. We have approached [http://rspec.info/ RSpec] testing framework. The UI feature tests are conducted manually.

===JavaScript Chart===
To validate all functionality of the chart when adding new features or fixing old ones, the following criteria were tested manually for expected functionality:

# Chart is displaying correctly
## Bars are showing up where expected
## Bar annotations are showing the expected value
## Criteria labels are for the correct bar and displaying correct values
## Hover text is displaying the correct values
## Null values are not present on the chart
## Correct colors are used for the multi-round view
# Show Labels checkbox works as expected
# Round Criteria is displaying correctly
## Round dropdown menu shows all rounds for the assignment
## Selecting a round changes the criteria checkboxes
## All checkboxes are displayed with appropriate text
## Checkboxes correctly remove or add criterion bars to the chart

===RSpec Tests===
We have modified one of the existing tests for grades controller because the addition of new functionality broke that particular test. The added test handles the chart functionality correctly.

== spec/controllers/grades_controller_spec.rb ==
describe '#view' do
before(:each) do
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
allow(Participant).to receive(:where).with(parent_id: 1).and_return([participant])
allow(AssignmentParticipant).to receive(:find).with(1).and_return(participant)
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
end
context 'when current assignment does not vary rubric by round' do
it 'calculates scores and renders grades#view page' do
allow(AssignmentQuestionnaire).to receive(:where).with(assignment_id: 1, used_in_round: 2).and_return([])
# added AssignmentQuestionnaire 'allow' below to handle chart functionality added in E1859
allow(AssignmentQuestionnaire).to receive(:where).with(assignment_id: 1, questionnaire_id: 1).and_return([assignment_questionnaire])
allow(ReviewResponseMap).to receive(:get_assessments_for).with(team).and_return([review_response])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@questions)[:review].size).to eq(1)
expect(response).to render_template(:view)
end
end
end

E1859 Visualizations for Instructors

2018-12-08T05:28:38Z

Jbcolli8: /* app/views/grades/_team_charts.html.erb */

== Introduction ==
Expertiza is an online assignment grading platform. Instructors can create assignments and implement peer reviews for submitted assignments. This project concerns the creation of a system for visualizing student performance on those assignments, primarily as graded in peer reviews. Graphs will be made to show various rubric criteria and the class' performance on the criteria. If the criteria are the same for multiple stages of review, an instructor should be able to compare performance over time or between reviews.

__TOC__

== Project Purpose ==
Our task is to provide an interactive visualization or a table for instructors that shows how their class performed on selected rubric criteria. Such feature would be immensely helpful for instructors as it would assist them to identify what they need to focus more attention on. For example, creating a graph showing the average scores for all or a certain subset of main rubric criteria (questionnaire). If the average score of the class on selected criteria (question) is low means the instructor can emphasize more on the learning materials related to it.

== Proposed Changes ==
The visualizations will be implemented as either a single or stacked bar chart with a bar for each of the selected criteria to be observed. If a single bar, then the height of the bar will be the total class average, but a stacked bar chart may be better to show the percentage of the class that received each score. The changes made to the expertiza project will primarily include HTML/ERB changes to the view files to accommodate the added charts on the page and the necessary javascript to allow responsive design. Brief controller modifications will be made to facilitate database filtering to get the displayed data.

1. On clicking Manage and then on assignments, following page appears.

[[File:S1.JPG]]

2. Click on 'view score' icon of an assignment. The summary report page of the selected assignment comes up.

[[File:A0.jpg]]

3. Following are mockup screens which we wish to create:

a) Instructor would select the round and rubric criteria of the assignment for which he/she wants to view the class performance.

[[File:A1.jpg]]

b) The bar graph of the class performance for those criteria would be displayed.

[[File:Try.jpg]]

== Project Design ==

==== Design Flow ====

The flowchart representing graphical flow of an instructor visiting view scores under assignments is given below:

[[File:A3.png]]

==== Tools and Design Choice ====

We have used the lightweight [https://developers.google.com/chart/ Google Charts] library for displaying the chart data on the page, with standard HTML for all of the options and dropdowns for option selection. Google Charts was chosen because of its high compatibility, full option set, and comparable graphical quality to the rest of expertiza while keeping a small JS footprint, which should help prevent slow page responsiveness.

==== Visualization ====

The following graph shows the view of the 'view scores' page after the modifications. The instructor selects a subset of rubric criteria for which he/she wants to know how a class performed for a particular round. A bar graph of the average score of the class for that subset of criteria is displayed.

[[File:1859_Chart_Preview.png]]

The above graph shows an average score of the class for 5 rubric criteria in Round 1 selected by the instructor. A live demo with randomly generated data can be found on [https://jsfiddle.net/Jereman/5uxqr92y/ JSFiddle]

== Files Involved ==
We have implemented a new partial file criteria_charts to the team_chart that display the bar graph with existing data collected by the grades controller methods to the view page.

Modified files:
<div style="display: inline-block">
<pre>
app/controllers/grades_controller.rb

app/views/grades/_teams.html.erb

app/views/grades/_criteria_charts.html.erb

app/views/grades/_team_charts.html.erb

</pre>
</div>

=== Code ===

== app/views/grades/_criteria_charts.html.erb ==
<html>
<head>
<%= content_tag :div, class: "chartdata_information", data: {chartdata: @chartdata} do %>
<% end %>
<%= content_tag :div, class: "text_information", data: {text: @text} do %>
<% end %>
<%= content_tag :div, class: "minmax_information", data: {minmax: @minmax} do %>
<% end %>
<script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
<script type="text/javascript">
google.charts.load('current', {packages: ['corechart', 'bar']});
//Display Options
var showLabels = true;
var barColors = [ // Other colors generated from the expertiza base red
'#A90201', // using paletton.com
'#018701',
'#016565',
'#A94D01'
];
function getData(){ //Loads all chart data from the page
chartData = $('.chartdata_information').data('chartdata');
chartText = $('.text_information').data('text');
chartRange = $('.minmax_information').data('minmax');
for (var i = 0; i < chartData.length; i++){ //Set all the criteriaSelected to true
var criteria = [];
for (var j = 0; j < chartData[i].length; j++){
criteria.push(true);
}
criteriaSelected.push(criteria);
}
}
function generateData() { //Generates random data for testing
var rounds = 3;
for(var i = 0; i < rounds; i++) {
var criteriaNum = Math.floor(Math.random() * 5 + 5); //Random number of criteria
var round = [];
var criteria = [];
for(var j = 0; j < criteriaNum; j++) {
round.push(Math.floor(Math.random() * 101)); //Random score for each criterion
criteria.push(true); //Everything starts out true
}
chartData.push(round);
criteriaSelected.push(criteria);

chartOptions = { //Render options for the chart
title: 'Class Average on Criteria',
titleTextStyle: {
fontName: 'arial',
fontSize: 18,
italic: false,
bold: true
chart = new google.visualization.ColumnChart(document.getElementById('chart_div'));
var checkBox = document.getElementById("labelCheck");
checkBox.checked = true;
checkBox.style.display = "inline";
updateChart(currentRound);
loadRounds(); }
function updateChart(roundNum) { //Updates the chart with a new round number and renders
currentRound = roundNum;
renderChart();
loadCriteria();
function renderChart() { //Renders the chart if changes have been made
var data = loadData();
chartOptions.vAxis.viewWindow.max = 5;
chartOptions.vAxis.viewWindow.min = 0;
if (chartRange[currentRound]) { //Set axis ranges if they exist
if (chartRange[currentRound][1])
chartOptions.vAxis.viewWindow.max = chartRange[currentRound][1];
if (chartRange[currentRound][0])
chartOptions.vAxis.viewWindow.min = chartRange[currentRound][0];
}
chart.draw(data, chartOptions);
}

chartOptions.hAxis.ticks = [];
var rowCount = 1;
for(var i = 0; i < chartData[currentRound].length; i++) { //Add a chart row for each criterion if not null
if (criteriaSelected[currentRound][i] && chartData[currentRound][i]) {
data.addRow([rowCount, chartData[currentRound][i], barColors[0], (showLabels) ? chartData[currentRound][i].toFixed(1).toString() : ""]);
chartOptions.hAxis.ticks.push({v: rowCount++, f: (i+1).toString()});
}
}

var data = new google.visualization.DataTable();
data.addColumn('number', 'Criterion');
var i;
for(i = 0; i < roundNum; i++) { //Add all columns for the data
data.addColumn('number', 'Round ' + (i+1).toString());
data.addColumn({type: 'string', role: 'style'}); //column for specifying the bar color
data.addColumn({type: 'string', role: 'annotation'});

var newRow = [];
var elementsAdded = false;
newRow.push(rowCount);
for(var j = 0; j < roundNum; j++) { //If the round has the criterion, add it
if (chartData[j][i]) {
newRow.push(chartData[j][i]);
elementsAdded = true;
} else {
newRow.push(null);
}
newRow.push(barColors[j % barColors.length]); //Add column color
if (chartData[j] && chartData[j][i] && showLabels)
newRow.push(chartData[j][i].toFixed(1).toString()); //Add column annotations
else
newRow.push("");
}
function loadCriteria() { //Creates the criteria check boxes
var form = document.getElementById("chartCriteria");
while (form.firstChild) //Clear out the old check boxes
form.removeChild(form.firstChild);
if (currentRound == -1) //Don't show criteria for 'all rounds'
return;
chartData[currentRound].forEach(function(dat, i) {
var checkbox = document.createElement('input');
checkbox.type = "checkbox";
checkbox.id = "checkboxoption" + i;
checkbox.onclick = function() { //Register callback to toggle the criterion
checkboxUpdate(i);
}
var label = document.createElement('label')

<form id="chartOptions" name="chartOptions">
<select id="chartRounds" name="rounds"
onChange="updateChart(document.chartOptions.chartRounds.options[document.chartOptions.chartRounds.options.selectedIndex].value)" style = "display: none">
</select>
<label><input type="checkbox" id = "labelCheck" checked="checked" style="display: none" onclick="showLabels = !showLabels; renderChart();">Show
Labels</label>
</form>
<div id="chartCriteria" name="chartCriteria">
</div>

== app/controllers/grades_controller.rb ==

def action_allowed?
case params[:action]
when 'view_my_scores'
['Instructor',
'Teaching Assistant',
'Administrator',
'Super-Administrator',
'Student'].include? current_role_name and
are_needed_authorizations_present?(params[:id], "reader", "reviewer") and
check_self_review_status
when 'view_team'
if ['Student'].include? current_role_name # students can only see the head map for their own team
participant = AssignmentParticipant.find(params[:id])
session[:user].id == participant.user_id
else
true
end
else
['Instructor',
'Teaching Assistant',
'Administrator',
'Super-Administrator'].include? current_role_name
end
end
# collects the question text for display on the chart
# Added as part of E1859
def assign_chart_text
@text = []
(1..@assignment.num_review_rounds).to_a.each do |round|
question = @questions[('review' + round.to_s).to_sym]
@text[round - 1] = []
next if question.nil?
(0..(question.length - 1)).to_a.each do |q|
@text[round - 1][q] = question[q].txt
end
end
end

# find the maximum and minimum scores for each questionnaire round
# Added as part of E1859
def assign_minmax(questionnaires)
@minmax = []
questionnaires.each do |questionnaire|
next if questionnaire.symbol != :review
round = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).first.used_in_round
next if round.nil?
@minmax[round - 1] = []
@minmax[round - 1][0] = if !questionnaire.min_question_score.nil? and questionnaire.min_question_score < 0
questionnaire.min_question_score
else
0
end
@minmax[round - 1][1] = if !questionnaire.max_question_score.nil?
questionnaire.max_question_score
else
5
end
end
end
# this method collects and averages all the review scores across teams
# Added as part of E1859
def assign_chart_data
@rounds = @assignment.num_review_rounds
@chartdata = []
(1..@rounds).to_a.each do |round|
@teams = AssignmentTeam.where(parent_id: @assignment.id)
@teamids = []
@result = []
@responseids = []
@scoreviews = []
(0..(@teams.length - 1)).to_a.each do |t|
@teamids[t] = @teams[t].id
@result[t] = ResponseMap.find_by_sql ["SELECT id FROM response_maps
WHERE type = 'ReviewResponseMap' AND reviewee_id = ?", @teamids[t]]
@responseids[t] = []
@scoreviews[t] = []
(0..(@result[t].length - 1)).to_a.each do |r|
@responseids[t][r] = Response.find_by_sql ["SELECT id FROM responses
WHERE round = ? AND map_id = ?", round, @result[t][r]]
@scoreviews[t][r] = Answer.where(response_id: @responseids[t][r][0]) unless @responseids[t][r].empty?
end
end
@chartdata[round - 1] = []
# because the nth first elements could be nil
# iterate until a non-nil value is found or move to next round
t = 0
r = 0
t += 1 while @scoreviews[t].nil?
while t < @scoreviews.length and @scoreviews[t][r].nil?
if r < @scoreviews[t].length - 1
r += 1
else
def assign_chart_data
end
end
next if t >= @scoreviews.length
(0..(@scoreviews[t][r].length - 1)).to_a.each do |q|
sum = 0
counter = 0
def retrieve_questions(questionnaires)
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
@questions[questionnaire_symbol] = questionnaire.questions
end
end
def update
if format("%.2f", total_score) != params[:participant][:grade]
participant.update_attribute(:grade, params[:participant][:grade])
message = if participant.grade.nil?
"The computed score will be used for " + participant.user.name + "."
else
"A score of " + params[:participant][:grade] + "% has been saved for " + participant.user.name + "."
end
end
flash[:note] = message
redirect_to action: 'edit', id: params[:id]

== app/views/grades/_team_charts.html.erb ==
<pre>
<br> <br>
<%= render :partial => 'criteria_charts' %>
<br>

<a href="#" name='team-chartLink' onClick="toggleElement('team-chart', 'stats');return false;">Hide stats</a>
<br>
<TR style ="background-color: white;" class="team" id="team-chart">
<th>

<div class="circle" id="average-score">

</div>
Class Average
</th>
<TH COLSPAN="8">
<img src="<%= @average_chart %>" ><br>
Class Distribution
<br>
</th>
<TH WIDTH="9"> </th>
</TR>

<script type="text/javascript">
var myCircle = Circles.create({
id: 'average-score',
radius: 50,
value: <%= @avg_of_avg.to_i %>,
maxValue: 100,
width: 15,
text: '<%=@avg_of_avg.to_i%>',
colors: ['#FFEB99', '#FFCC00'],
duration: 700,
textClass: 'circles-final'
});
</script>

<style>
.circles-final{
font-size: 16px !important;
}
</style>
</pre>

== Test Plan ==
The specification of the project does not require us to use automated tests. However, we have tested the existing tests after the addition of new features to the grades_controller. We have approached [http://rspec.info/ RSpec] testing framework. The UI feature tests are conducted manually.

===JavaScript Chart===
To validate all functionality of the chart when adding new features or fixing old ones, the following criteria were tested manually for expected functionality:

# Chart is displaying correctly
## Bars are showing up where expected
## Bar annotations are showing the expected value
## Criteria labels are for the correct bar and displaying correct values
## Hover text is displaying the correct values
## Null values are not present on the chart
## Correct colors are used for the multi-round view
# Show Labels checkbox works as expected
# Round Criteria is displaying correctly
## Round dropdown menu shows all rounds for the assignment
## Selecting a round changes the criteria checkboxes
## All checkboxes are displayed with appropriate text
## Checkboxes correctly remove or add criterion bars to the chart

===RSpec Tests===
We have modified one of the existing tests for grades controller because the addition of new functionality broke that particular test. The added test handles the chart functionality correctly.

== spec/controllers/grades_controller_spec.rb ==
describe '#view' do
before(:each) do
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
allow(Participant).to receive(:where).with(parent_id: 1).and_return([participant])
allow(AssignmentParticipant).to receive(:find).with(1).and_return(participant)
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
end
context 'when current assignment does not vary rubric by round' do
it 'calculates scores and renders grades#view page' do
allow(AssignmentQuestionnaire).to receive(:where).with(assignment_id: 1, used_in_round: 2).and_return([])
# added AssignmentQuestionnaire 'allow' below to handle chart functionality added in E1859
allow(AssignmentQuestionnaire).to receive(:where).with(assignment_id: 1, questionnaire_id: 1).and_return([assignment_questionnaire])
allow(ReviewResponseMap).to receive(:get_assessments_for).with(team).and_return([review_response])
params = {id: 1}
get :view, params
expect(controller.instance_variable_get(:@questions)[:review].size).to eq(1)
expect(response).to render_template(:view)
end
end
end

E1859 Visualizations for Instructors

2018-12-06T15:24:10Z

Jbcolli8: /* Test Plan */

E1859 Visualizations for Instructors

2018-12-04T16:06:14Z

Jbcolli8: /* Visualization */

File:1859 Chart Preview.png

2018-12-04T16:05:23Z

Jbcolli8:

E1859 Visualizations for Instructors

2018-12-04T15:55:11Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-12-02T21:12:52Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-29T19:25:34Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-28T19:47:25Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-28T16:37:43Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-28T16:22:45Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-28T16:21:53Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-25T22:14:40Z

Jbcolli8:

E1859 Visualizations for Instructors

2018-11-19T23:22:54Z

Jbcolli8: /* Files Involved */

E1859 Visualizations for Instructors

2018-11-19T23:17:32Z

Jbcolli8: /* Visualization */

File:JsfiddleBarChart.png

2018-11-19T23:16:06Z

Jbcolli8:

E1859 Visualizations for Instructors

2018-11-17T15:55:23Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-17T15:31:09Z

Jbcolli8: /* Visualization */

E1859 Visualizations for Instructors

2018-11-13T20:57:48Z

Jbcolli8:

E1859 Visualizations for Instructors

2018-11-13T20:51:28Z

Jbcolli8:

E1859 Visualizations for Instructors

2018-11-12T21:26:01Z

Jbcolli8:

== Introduction ==
This project concerns the creation of a system for visualizing student performance on assignments in the Expertiza system. Graphs will be made to show various rubric criteria and the class' performance on the criteria. If the criteria are the same for multiple stages of review, an instructor should be able to compare performance over time or between reviews.

__TOC__

== Proposed Changes ==
The visualizations will be implemented as either a single or stacked bar chart with a bar for each of the selected criteria to be observed. If a single bar, then the height of the bar will be the total class average, but a stacked bar chart may be better to show the percentage of the class that received each score. The changes made to the expertiza project will primarily include HTML/ERB changes to the view files to accommodate the added charts on the page and the necessary javascript to allow responsive design. Brief controller modifications will be made to facilitate database filtering to get the displayed data.

E1859 Visualizations for Instructors

2018-11-12T21:22:02Z

Jbcolli8:

E1859 Visualizations for Instructors

2018-11-12T21:06:33Z

Jbcolli8:

E1859 Visualizations for Instructors

2018-11-12T21:04:17Z

Jbcolli8:

= Introduction =
This project concerns the creation of a system for visualizing student performance on assignments in the Expertiza system. Graphs will be made to show various rubric criteria and the class' performance on the criteria. If the criteria are the same for multiple stages of review, it is desirable to be able to compare performance over time or between reviews.

= Proposed Changes =

E1859 Visualizations for Instructors

2018-11-12T20:59:00Z

Jbcolli8: Created page with "= Introduction = = Proposed Changes ="

= Introduction =

= Proposed Changes =

E1845 Issues Related to Security

2018-11-03T14:51:56Z

Jbcolli8:

This page documents changes made to the Expertiza system as part of an OSS project on sorting issues related to roles and user accounts.

== Peer Testing ==
In order to test all functionality, a super-administrator account is needed. The following account can be used in a standard Expertiza deployment:

:- Super_administrator2 : ''password''

Following the installation and setup of the Expertiza system with the scrubbed database, testing of the project functionality can be done as follows.
:'''A. User Deletion'''
::1. Sign in as a Super-Administrator (see above for sample account)
::2. Navigate to Administration>Show>Instructors
:::i. Select one of the instructor accounts
:::ii. On the account page, click the delete link at the bottom
:::iii. Assuming the instructor account is not tied to any assignments or other associations, the account will be gone from the list. If there is an issue, an error will be displayed at the top of the page.
::3. Navigate to Administration>Show>Administrators
:::i. Select one of the administrator accounts
:::ii. On the account page, click the delete link at the bottom
:::iii. Assuming the administrator account is not tied to any assignments or other associations, the account will be gone from the list. If there is an issue, an error will be displayed at the top of the page.
::4. Errors may appear on the page when an account to be deleted still has relations to other assignments, teams, etc. The content and quality of these error messages is outside the scope of this project; some may show an English error, others may return an SQL error. This is the intended functionality as of the time this project was written - this project only concerns successful deletion in situations where deletion should be working.

:'''B. Role Creation'''
::1. Sign in as a Super-Administrator
::2. Navigate to Administration>Setup>Roles
::3. Ensure that there is no link on the page to create a new role
::4. Ensure that manually navigating to /roles/new results in an error message on the page.

== User Deletion ==

=== Background ===
The majority of the project was related to solving issues regarding the deletion of Administrator and Instructor accounts. Administrator and Instructor are both account types that inherit behavior from User but are handled and deleted in different codepaths. Furthermore, properties are used on a User that aren't on an Administrator, such as team ids or course associations.

=== Changes ===
The first step towards fixing the deletion functionality was to sort out the routing issues. No listing in the routing table existed for administrator deletion, and no controller method existed for neither administrator nor instructor deletion. With both of those in place, the only issue left was the deletion functionality.

Because of the varying properties on Users and Administrators, and due to some database table migrations that were put into effect earlier, the rails system was unable to find <code>user_id</code> columns in the Users table when trying to delete the Administrator and Instructor accounts. The earlier migration had renamed it to <code>team_id</code> when team functionality was changed, but since Administrator and Instructor don't join teams, that id was invalid. A new migration was created to re-add the <code>user_id</code> column to the table as a blank column just used for SQL matching.

In order to maintain DRY principles and support future code maintenance, a helper method was created for use with deleting Users, Administrator, and Instructor. By using a static class method, both UserController and AdminController could use the same underlying functionality for deleting User objects while customizing the flash message and the redirect url. The changes made to both controllers is visible in the UML diagram below and the before and after code segments. The code segments only show the destroy method for the users controller, as the code is nearly identical in the administrator controller for both Instructor and Administrator deletion, with the only changes being to the name of the position being passed and the <code>redirect_to</code> path after the deletion.

[[File:E1845Changes.jpg]]

'''Before:''' (users_controller.rb)
<pre>
def destroy
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
flash[:note] = undo_link("The user \"#{@user.name}\" has been successfully deleted.")
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end
</pre>

'''After:''' (users_controller.rb)
<pre>
def destroy
begin
flash[:note] = undo_link(UsersController.destroy_helper(params, 'user'))
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end

def self.destroy_helper(params, position)
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
"The #{position} \"#{@user.name}\" has been successfully deleted."
rescue StandardError
raise
end
end
</pre>

== Role Creation ==

=== Background ===
In Expertiza, each user has a role in the system which dictates the availability of functionality to the user. The current roles in the system are Administrator, Instructor, Student, Super-Administrator, Teaching Assistant, and Unregistered User. The other focus of this project was to remove the ability to add new roles to the system. The functionality was previously available only to Super Administrators, but the functionality was deemed unnecessary and a potential issue to keep around. The solution simply involved removing the <code> New</code> button from the Roles list view and preventing any new functionality in the Role controller.

=== Changes ===
'''Before:''' (roles_controller.rb)
<code>
def new
@role = Role.new
foreign
end
</code>
In the controller, the above was changed to the following in order to prevent the functionality on the GUI side.

'''After:''' (roles_controller.rb)
<code>
def new
flash[:error] = 'New Roles cannot be created.'
redirect_to roles_path
end
</code>

== RSpec Test Cases ==

In order to develop test cases for the functionality added and removed in this project, both an admin_controller_spec.rb and a roles_controller_spec.rb file were created and added to the RSpec test environment.

The admin tests include building and deleting both Administrator and Instructor accounts using Capybara for testing the front-end web functionality.

To test the role creation, Capybara was again used to check that the web page did not have any button for "New Role" and that navigating to the page manually resulted in an error.

E1845 Issues Related to Security

2018-11-03T04:49:09Z

Jbcolli8:

This page documents changes made to the Expertiza system as part of an OSS project on sorting issues related to roles and user accounts.

== Peer Testing ==
In order to test all functionality, a super-administrator account is needed. The following account can be used in a standard Expertiza deployment:

:- Super_administrator2 : ''password''

Following the installation and setup of the Expertiza system with the scrubbed database, testing of the project functionality can be done as follows.
:'''A. User Deletion'''
::1. Sign in as a Super-Administrator (see above for sample account)
::2. Navigate to Administration>Show>Instructors
:::i. Select one of the instructor accounts
:::ii. On the account page, click the delete link at the bottom
:::iii. Assuming the instructor account is not tied to any assignments or other associations, the account will be gone from the list. If there is an issue, an error will be displayed at the top of the page.
::3. Navigate to Administration>Show>Administrators
:::i. Select one of the administrator accounts
:::ii. On the account page, click the delete link at the bottom
:::iii. Assuming the administrator account is not tied to any assignments or other associations, the account will be gone from the list. If there is an issue, an error will be displayed at the top of the page.

:'''B. Role Creation'''
::1. Sign in as a Super-Administrator
::2. Navigate to Administration>Setup>Roles
::3. Ensure that there is no link on the page to create a new role
::4. Ensure that manually navigating to /roles/new results in an error message on the page.

== User Deletion ==

=== Background ===
The majority of the project was related to solving issues regarding the deletion of Administrator and Instructor accounts. Administrator and Instructor are both account types that inherit behavior from User but are handled and deleted in different codepaths. Furthermore, properties are used on a User that aren't on an Administrator, such as team ids or course associations.

=== Changes ===
The first step towards fixing the deletion functionality was to sort out the routing issues. No listing in the routing table existed for administrator deletion, and no controller method existed for neither administrator nor instructor deletion. With both of those in place, the only issue left was the deletion functionality.

Because of the varying properties on Users and Administrators, and due to some database table migrations that were put into effect earlier, the rails system was unable to find <code>user_id</code> columns in the Users table when trying to delete the Administrator and Instructor accounts. The earlier migration had renamed it to <code>team_id</code> when team functionality was changed, but since Administrator and Instructor don't join teams, that id was invalid. A new migration was created to re-add the <code>user_id</code> column to the table as a blank column just used for SQL matching.

In order to maintain DRY principles and support future code maintenance, a helper method was created for use with deleting Users, Administrator, and Instructor. By using a static class method, both UserController and AdminController could use the same underlying functionality for deleting User objects while customizing the flash message and the redirect url. The changes made to both controllers is visible in the UML diagram below and the before and after code segments. The code segments only show the destroy method for the users controller, as the code is nearly identical in the administrator controller for both Instructor and Administrator deletion, with the only changes being to the name of the position being passed and the <code>redirect_to</code> path after the deletion.

[[File:E1845Changes.jpg]]

'''Before:''' (users_controller.rb)
<pre>
def destroy
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
flash[:note] = undo_link("The user \"#{@user.name}\" has been successfully deleted.")
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end
</pre>

'''After:''' (users_controller.rb)
<pre>
def destroy
begin
flash[:note] = undo_link(UsersController.destroy_helper(params, 'user'))
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end

def self.destroy_helper(params, position)
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
"The #{position} \"#{@user.name}\" has been successfully deleted."
rescue StandardError
raise
end
end
</pre>

== Role Creation ==

=== Background ===
In Expertiza, each user has a role in the system which dictates the availability of functionality to the user. The current roles in the system are Administrator, Instructor, Student, Super-Administrator, Teaching Assistant, and Unregistered User. The other focus of this project was to remove the ability to add new roles to the system. The functionality was previously available only to Super Administrators, but the functionality was deemed unnecessary and a potential issue to keep around. The solution simply involved removing the <code> New</code> button from the Roles list view and preventing any new functionality in the Role controller.

=== Changes ===
'''Before:''' (roles_controller.rb)
<code>
def new
@role = Role.new
foreign
end
</code>
In the controller, the above was changed to the following in order to prevent the functionality on the GUI side.

'''After:''' (roles_controller.rb)
<code>
def new
flash[:error] = 'New Roles cannot be created.'
redirect_to roles_path
end
</code>

== RSpec Test Cases ==

In order to develop test cases for the functionality added and removed in this project, both an admin_controller_spec.rb and a roles_controller_spec.rb file were created and added to the RSpec test environment.

The admin tests include building and deleting both Administrator and Instructor accounts using Capybara for testing the front-end web functionality.

To test the role creation, Capybara was again used to check that the web page did not have any button for "New Role" and that navigating to the page manually resulted in an error.

E1845 Issues Related to Security

2018-11-03T04:46:59Z

Jbcolli8:

This page documents changes made to the Expertiza system as part of an OSS project on sorting issues related to roles and user accounts.

== Peer Testing ==
In order to test all functionality, a super-administrator account is needed. The following account can be used in a standard Expertiza deployment:

:- Super_administrator2 : ''password''

Following the installation and setup of the Expertiza system with the scrubbed database, testing of the project functionality can be done as follows.
:'''A. User Deletion'''
::1. Sign in as a Super-Administrator (see above for sample account)
::2. Navigate to Administration>Show>Instructors
:::i. Select one of the instructor accounts
:::ii. On the account page, click the delete link at the bottom
:::iii. Assuming the instructor account is not tied to any assignments or other associations, the account will be gone from the list. If there is an issue, an error will be displayed at the top of the page.
::3. Navigate to Administration>Show>Administrators
:::i. Select one of the administrator accounts
:::ii. On the account page, click the delete link at the bottom
:::iii. Assuming the administrator account is not tied to any assignments or other associations, the account will be gone from the list. If there is an issue, an error will be displayed at the top of the page.

:'''B. Role Creation'''
::1. Sign in as a Super-Administrator
::2. Navigate to Administration>Setup>Roles
::3. Ensure that there is no link on the page to create a new role
::4. Ensure that manually navigating to /roles/new results in an error message on the page.

== User Deletion ==

=== Background ===
The majority of the project was related to solving issues regarding the deletion of Administrator and Instructor accounts. Administrator and Instructor are both account types that inherit behavior from User but are handled and deleted in different codepaths. Furthermore, properties are used on a User that aren't on an Administrator, such as team ids or course associations.

=== Changes ===
The first step towards fixing the deletion functionality was to sort out the routing issues. No listing in the routing table existed for administrator deletion, and no controller method existed for neither administrator nor instructor deletion. With both of those in place, the only issue left was the deletion functionality.

Because of the varying properties on Users and Administrators, and due to some database table migrations that were put into effect earlier, the rails system was unable to find <code>user_id</code> columns in the Users table when trying to delete the Administrator and Instructor accounts. The earlier migration had renamed it to <code>team_id</code> when team functionality was changed, but since Administrator and Instructor don't join teams, that id was invalid. A new migration was created to re-add the <code>user_id</code> column to the table as a blank column just used for SQL matching.

In order to maintain DRY principles and support future code maintenance, a helper method was created for use with deleting Users, Administrator, and Instructor. By using a static class method, both UserController and AdminController could use the same underlying functionality for deleting User objects while customizing the flash message and the redirect url. The changes made to both controllers is visible in the UML diagram below and the before and after code segments.

[[File:E1845Changes.jpg]]

'''Before:''' (users_controller.rb)
<pre>
def destroy
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
flash[:note] = undo_link("The user \"#{@user.name}\" has been successfully deleted.")
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end
</pre>

'''After:''' (users_controller.rb)
<pre>
def destroy
begin
flash[:note] = undo_link(UsersController.destroy_helper(params, 'user'))
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end

def self.destroy_helper(params, position)
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
"The #{position} \"#{@user.name}\" has been successfully deleted."
rescue StandardError
raise
end
end
</pre>

== Role Creation ==

=== Background ===
In Expertiza, each user has a role in the system which dictates the availability of functionality to the user. The current roles in the system are Administrator, Instructor, Student, Super-Administrator, Teaching Assistant, and Unregistered User. The other focus of this project was to remove the ability to add new roles to the system. The functionality was previously available only to Super Administrators, but the functionality was deemed unnecessary and a potential issue to keep around. The solution simply involved removing the <code> New</code> button from the Roles list view and preventing any new functionality in the Role controller.

=== Changes ===
'''Before:''' (roles_controller.rb)
<code>
def new
@role = Role.new
foreign
end
</code>
In the controller, the above was changed to the following in order to prevent the functionality on the GUI side.

'''After:''' (roles_controller.rb)
<code>
def new
flash[:error] = 'New Roles cannot be created.'
redirect_to roles_path
end
</code>

== RSpec Test Cases ==

In order to develop test cases for the functionality added and removed in this project, both an admin_controller_spec.rb and a roles_controller_spec.rb file were created and added to the RSpec test environment.

The admin tests include building and deleting both Administrator and Instructor accounts using Capybara for testing the front-end web functionality.

To test the role creation, Capybara was again used to check that the web page did not have any button for "New Role" and that navigating to the page manually resulted in an error.

E1845 Issues Related to Security

2018-11-03T04:30:13Z

Jbcolli8:

E1845 Issues Related to Security

2018-11-03T01:39:59Z

Jbcolli8:

This page documents changes made to the Expertiza system as part of an OSS project on sorting issues related to roles and user accounts.

== Testing ==
In order to test all functionality, a super-administrator account is needed. The following account can be used in a standard Expertiza deployment:

:- Super_administrator2 : ''password''

== User Deletion ==
The majority of the project was related to solving issues regarding the deletion of Administrator and Instructor accounts. Administrator and Instructor both inherit behavior from User but are handled and deleted in different codepaths. Furthermore, properties are used on a User that aren't on an Administrator, such as team ids or course associations.

The first step towards fixing the deletion functionality was to sort out the routing issues. No listing in the routing table existed for administrator deletion, and no controller method existed for neither administrator nor instructor deletion. With both of those in place, the only issue left was the deletion functionality.

In order to maintain DRY principles and support future code maintenance, a helper method was created for use with deleting Users, Administrator, and Instructor. By using a static class method, both UserController and AdminController could use the same underlying functionality for deleting User objects while customizing the flash message and the redirect url. The changes made to both controllers is visible in the UML diagram below and the before and after code segments.

[[File:E1845Changes.jpg]]

'''Before:''' (users_controller.rb)
<code>
def destroy
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
flash[:note] = undo_link("The user \"#{@user.name}\" has been successfully deleted.")
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end
</code>

'''After:''' (users_controller.rb)
<code>
def destroy
begin
flash[:note] = undo_link(UsersController.destroy_helper(params, 'user'))
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end

def self.destroy_helper(params, position)
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
"The #{position} \"#{@user.name}\" has been successfully deleted."
rescue StandardError
raise
end
end
</code>

== New Roles ==
One other focus of the project was to remove the ability to add new roles to the expertiza system. This simply involved removing the <code> New</code> button from the Roles list view and preventing any new functionality in the Role controller.
<code>
def new
@role = Role.new
foreign
end
</code>
In the controller, the above was changed to the following in order to prevent the functionality on the GUI side.
<code>
def new
flash[:error] = 'New Roles cannot be created.'
redirect_to roles_path
end
</code>

== Test Cases ==

E1845 Issues Related to Security

2018-11-03T01:15:16Z

Jbcolli8: /* Tests */

The scope of this project was to sort out issues related to roles and user accounts on the Expertiza system.

== Testing ==
In order to test all functionality, a super-administrator account is needed. The following account can be used in a standard Expertiza deployment:

:- Super_administrator2 : ''password''

== User Deletion ==
The majority of the project was related to solving issues regarding the deletion of Administrator and Instructor accounts. Administrator and Instructor both inherit behavior from User but are handled and deleted in different codepaths. Furthermore, properties are used on a User that aren't on an Administrator, such as team ids or course associations.

The first step towards fixing the deletion functionality was to sort out the routing issues. No listing in the routing table existed for administrator deletion, and no controller method existed for neither administrator nor instructor deletion. With both of those in place, the only issue left was the deletion functionality.

In order to maintain DRY principles and support future code maintenance, a helper method was created for use with deleting Users, Administrator, and Instructor. By using a static class method, both UserController and AdminController could use the same underlying functionality for deleting User objects while customizing the flash message and the redirect url. The changes made to both controllers is visible in the UML diagram below and the before and after code segments.

[[File:E1845Changes.jpg]]

'''Before:''' (users_controller.rb)
<code>
def destroy
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
flash[:note] = undo_link("The user \"#{@user.name}\" has been successfully deleted.")
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end
</code>

'''After:''' (users_controller.rb)
<code>
def destroy
begin
flash[:note] = undo_link(UsersController.destroy_helper(params, 'user'))
rescue StandardError
flash[:error] = $ERROR_INFO
end
redirect_to action: 'list'
end

def self.destroy_helper(params, position)
begin
@user = User.find(params[:id])
AssignmentParticipant.where(user_id: @user.id).each(&:delete)
TeamsUser.where(user_id: @user.id).each(&:delete)
AssignmentQuestionnaire.where(user_id: @user.id).each(&:destroy)
# Participant.delete(true)
@user.destroy
"The #{position} \"#{@user.name}\" has been successfully deleted."
rescue StandardError
raise
end
end
</code>

== New Roles ==
One other focus of the project was to remove the ability to add new roles to the expertiza system. This simply involved removing the <code> New</code> button from the Roles list view and preventing any new functionality in the Role controller.
<code>
def new
@role = Role.new
foreign
end
</code>
In the controller, the above was changed to the following in order to prevent the functionality on the GUI side.
<code>
def new
flash[:error] = 'New Roles cannot be created.'
redirect_to roles_path
end
</code>

== Test Cases ==

E1845 Issues Related to Security

2018-11-03T00:41:12Z

Jbcolli8:

E1845 Issues Related to Security

2018-11-02T23:58:57Z

Jbcolli8:

E1845 Issues Related to Security

2018-11-02T21:57:32Z

Jbcolli8:

E1845 Issues Related to Security

2018-11-02T01:21:41Z

Jbcolli8:

File:E1845Changes.jpg

2018-11-02T01:15:06Z

Jbcolli8:

E1845 Issues Related to Security

2018-10-31T16:02:13Z

Jbcolli8:

E1845 Issues Related to Security

2018-10-31T15:17:44Z

Jbcolli8:

E1845 Issues Related to Security

2018-10-28T16:59:50Z

Jbcolli8:

E1845 Issues Related to Security

2018-10-28T16:49:25Z

Jbcolli8: Created page with "The scope of this project was to sort out issues related to roles and user accounts on the Expertiza system."

The scope of this project was to sort out issues related to roles and user accounts on the Expertiza system.