Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-04T19:38:42Z

Aspandit: /* Future Work */

__TOC__

===Team Members===
Daniel Burcal (djburcal@ncsu.edu)

Patrick Poggi (pfpoggi@ncsu.edu)

Ambareesh Pandit (aspandit@ncsu.edu)

Minghao Pan (mpan2@ncsu.edu)

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

== Problem Statement ==

A previous team has worked on creating this visualization graphic for Instructors, which can be found [https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_pO9BX7iPGNe95o/edit# here]. We are tasked with building upon the work they have performed as well as improving the visualization aspect for instructors. Specifically we can narrow the goals of this project as follows:

:#The Visualization of the compiled metrics is confusing. We will aim to use a more coherent color scheme from red to green for the graph. We want to allow the instructor to dynamically generate graphs with the data they request. We will separate the table into partials or use a scheme to only show the sections of the table the instructor requests
:#There are ways to compile review data together such that it is even easier for the instructor to identify weaknesses and strengths. To that end, we would like to integrate review performance by compiling various feedback data that is collected. This would include the number of reviews performed, the length of the reviews, the summary of the reviews, whether or not the reviewers uploaded a file in their review, the average ratings the reviewers received from authors.
:#Another useful feature would be the ability to visualize class performance on a certain rubric criteria. Further, if these criteria are common ones used between projects, it would be very helpful to be able to compare performance between assignments on the common criteria.

== Design Process Flow ==

Below you can see a flowchart representing the graphical flow of an instructor visiting the visualization page we are modifying.

[[File:Final_Project_Graphic_Flow.jpg|center]]

Once the instructor visits the visualization page, they will already see a bar graph displaying how all the teams scored on each rubric criteria. Below this will be buttons or some other method by which to select the data that you want. The whole process flow involves being able to traverse the visualization page in a quick and efficient manner, since oftentimes the instructor will visit the page often. Below we will go into our intended design route for this project.

== Design ==

Here is a mock-up of our intended page:

[[File:Screen_Shot_2018-04-06_at_5.14.11_PM.png|center|]]

As you can see, we will have menu options by which the instructor can choose which data members to show and likewise the type of graphic visual they would like to produce. This will make it so that the instructors can visualize only the data they want to, and in the form that gives them the most relevant information. We plan on using the ''flot javascript library'' to implement the graphic visuals, which will provide an easy and clear visual of the requested data. Under the visual, we will have a way to select between teams and individual students' data to further target the desired visual. The last team which worked on this project used the ''highcharts javascript library'', but we have decided to move to ''flot'' due to visual clarity and the ability to easily decide which data to display.

Another mock-up of how the UI could be designed, is that by visiting the visualization page, the instructor will see a graph followed by an array of buttons.

[[File:ClassPerformanceStackedBarChartsWithToolTips.JPG‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/ap3ba5gu/90/ jsfiddle] </div>]]

The chart above shows stacked bar charts of a single submission. Each bar represents a question from the submission and the colors represent the percentage of teams that earned a 0(red) through 5(green) on the submission.

[[File:Final_Project_Buttons.jpg|center]]

As you can see, we plan on implementing an array of buttons to carry out simple manipulations to data and to display only the data the instructor wants to. We plan on implementing buttons to change the graphic that is displayed, so that if an instructor wishes to see a pie chart or histogram, they can click the button and see the data in a different form. Below those buttons, there will be other ones which will direct the page on what type of table to display and with which information. The reason for these adjustments are that in the last semester's implementation, the table was quite lengthy, and this will make it more manageable by the instructor.

It is possible that if we are able to, we plan on implementing a drop down functionality like in the mock-up further up the page where you can be even more selective about the data you wish to display in the tables or in the graphics.

==Modified Files==
Generally we plan on modifying the same files as the previous group did. The controllers of grade and assignment are involved. For the view part, we will modify the view of grade and review_mapping. We may also create new view files.
app/controllers/grades_controller.rb

app/controllers/assignments_controller.rb

app/views/grades/view.html.erb (partials below)

app/views/grades/_teams.html.erb

app/views/grades/_team_title.html.erb

app/views/grades/_team_charts.html.erb

app/view/review_mapping/_review_report.html.erb

== Testing Plan ==
Since it is based on a previous project, we need to refactor some previous code while making sure the previous test files ('''assignments_controller_spec.rb''' and '''grades_controller_spec.rb''') still work. We are going to test new features we add in the future.

It is beyond the scope of the course to test the graphs. We will only test the Ruby code.The tests will most likely use RSpec and the existing factories in Expertiza.

As we will use Javascript to achieve an interactive visualization, we will test the functionality of Javascript codes manually.

== Implementation ==

=== Visualization ===

In order to Improve the visualization of the rubric question data, we decided to use the flot javascript library instead of highcharts. In order to accomplish this, we constructed an adapter that took the already generate highchart data by the previous team, and converted it to a representation required by our flot graph. This is done in the highchart_to_flot_adapter method in the app/controllers/grades_controller.rb file.

==== Color Scheme ====

For fixing the color scheme, we used the adapter that was made to obtain the correct data, and instead of using their randomly generated colors, in the adapter there was a 6 element array with colors from red to green. This was inputted into the data series as per the correct format flot requires. You can also see the result below, in the picture of the graph provided.

==== Rubric Representation ====

To implement this, in the adapter we formed the data series such that different review rounds would be separated and clustered among their own review questions. This allows an easier viewing of different review rounds in order to determine how the class improved. The data passed to the _team_charts.html.erb view file contains all of the questions for all review rounds associated with the assignment. In addition to implementing the flot graphical representation, we also created a tooltip which allows the instructor to see the percentage of people who scored a certain value on any rubric questions of any round.

Here is a picture of what the completed flot graph looks like:

[[File:Visualization_graph_complete.JPG‎‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/twwprx9d/1/ jsfiddle] </div>]]

====Code====
The ruby code printed below is the adapter that was made to convert the highchart series data into the form required by our flot plot in the method highchart_to_flot_adapter.
<pre class="code">
def highchart_to_flot_adapter(min, max, highchart_series_data)
flot_series_data = []
flot_categories = []
highchart_data = []
flot_data = []
j = 0
k = 0
rounds = 0
highchart_series_index = 0
review_round = highchart_series_data.to_a.reverse[0][:stack]
flot_colors = ["#FF0000", "#FF6600", "#FFCC00", "#CCFF00", "#66FF00", "#00FF00"] # These are the six colors from red to green

# This loop will look at every element of the highchart_series_data and use them to form the flot_series_data
# and flot_categories. Flot_series_data is of the form [{data: [[0,x], [1,x], [2,x], [3,x], [4,x], ...], color: "#......"},...].
# It is an array of hashes of the size of the number of different scores, which for us is 6: 0, 1, 2, 3, 4, 5. The first
# value in each of those arrays within the hash indicates the specific question, while the x indicates the percentage
# of people which scored a certain score on that question. Flot_categories is a hash of the form [[0,""], [1,""], [2,""]],
# where the first value in each of the inner arrays indicates the question number and the quotes indicate the name
# of that question.
highchart_series_data.to_a.reverse.each do |element|
highchart_data = element[:data]
stack = element[:stack]
round = stack.scan(/[0-9]/)
# This tells flot_categories and flot_series_data that it is a new round
unless stack.eql?(review_round)
rounds += 1
review_round = stack
k = 0
end
# Every sixth element tells flot_categories to create as many ticks as there were questions in that round
if highchart_series_index % 6 == 1
for i in 0..highchart_data.size-1
flot_categories.push([k + (rounds*highchart_data.size), "Rubric \##{k} Round \##{round[0]}"])
k += 1
end
end
# Pushes the data into flot_series_data in the correct form specified above
for i in 0..highchart_data.size-1
if rounds > 0
flot_series_data[j][:data].push([i + (rounds*highchart_data.size), highchart_data[i]])
end
if rounds.zero?
flot_data.push([i, highchart_data[i]])
end
end
flot_series_data.push(data: flot_data, color: flot_colors[j]) if rounds.zero?

j += 1
if j > max
j = 0
end
flot_data = []
highchart_data = []
highchart_series_index += 1
end

# This loop calculates the percentages and stores them in the correct data series
num_reviewees = 0
for i in 0..flot_series_data[0][:data].size-1
for j in 0..flot_series_data.size - 1
num_reviewees += flot_series_data[j][:data][i][1]
end
for j in 0..flot_series_data.size - 1
unless num_reviewees.zero?
flot_series_data[j][:data][i][1] /= num_reviewees.to_f
flot_series_data[j][:data][i][1] *= 100.0
end
end
num_reviewees = 0
end
[flot_series_data, flot_categories]
end
</pre>

Also, javascript code was added in order to produce the stacked bar chart as shown on the webpage.
<pre class="code">
<div id="flot_scores_on_rubric_questions" style="width:1000px;height:300px;"> </div>

<script type="text/javascript">
$(function () {
$.plot($("#flot_scores_on_rubric_questions"), <%= @flot_series_data.to_json.html_safe %>, {
xaxis: {
ticks: <%= @flot_categories.to_json.html_safe %>
},
yaxis: {
tickFormatter: function(val, axis) { return val < axis.max ? val.toFixed(2) : "Percentage of teams";}
},
grid: {
hoverable: true,
clickable: true
},
series: {
stack: true,
lines: {
show: false,
fill: true,
steps: 0
},
bars: {
show: true,
align: 'center',
barWidth: 1
}
}
});

$("<div id='flot_team_scores_tooltip'></div>").css({
position: "absolute",
display: "none",
border: "1px solid #fdd",
padding: "2px",
"background-color": "#fee",
opacity: 0.80
}).appendTo("body");

$("#flot_scores_on_rubric_questions").bind("plothover", function (event, pos, item) {

if (item) {
var x = item.datapoint[0],
y = item.datapoint[1];

$("#flot_team_scores_tooltip").html(item.series.xaxis.ticks[x].label + ": " + item.series.data[x][1].toFixed(2) + "% of the class scored " + item.seriesIndex)
.css({top: item.pageY+5, left: item.pageX+5})
.fadeIn(200);
} else {
$("#flot_team_scores_tooltip").hide();
}
});
</pre>

===Class Performance===
The Class Performance visualization allows the instructor to view a histogram of 0 to 5 scores for a particular assignment. Furthermore, the visualization allows the user to switch between the preliminary round and the final round as well as view a combined view. As with the rubric criteria visualization, hovering over a bar in the class performance visualization brings up a tooltip indicating the score and frequency of teams that earned that score.

[[File:Class_performance_graph.JPG‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/w17tdby1/1/ jsfiddle] </div>]]

====Code====
The ruby code added is below. These are additional methods in the grades controller that collects and adds the raw score counts for each team to the <code>@scores</code> instance variable
<pre class="code">
def add_scores_by_round
scores_by_team_round = get_raw_scores_by_team_round(@questions)
@scores[:teams].each_value do |value|
team_id = value[:team][:id]
value[:scores][:scores_by_round] = scores_by_team_round[:teams][team_id]
end
end

def get_raw_scores_by_team_round(questions)
scores = {}

scores[:teams] = {}
if !questions.nil? && !questions.empty?
@assignment.teams.collect {|team| team.id}.each do |team_id|
first_round_sym = (@assignment.num_review_rounds == 1) ? :review : :review1
scores[:teams][team_id] = get_team_raw_scores_by_round(team_id,questions[first_round_sym][0].questionnaire.id) if !questions[first_round_sym].nil? && !questions[first_round_sym].empty?
end
end
scores
end

def get_team_raw_scores_by_round(team_id, questionnaire_id)
scores = {}
maps = ResponseMap.where(reviewee_id: team_id, type: "ReviewResponseMap")
assessments_by_team_id = {}
res_round = {}
maps.each do |m|
responses = m.response.each{|r| r.response_id} # response_id is the actual response here
assessments_by_team_id[team_id] = [] if assessments_by_team_id[team_id].nil?
responses.each{|res| assessments_by_team_id[team_id] << res.id if res.is_submitted} if !responses.nil? && !responses.empty?
responses.each{|res| res_round[res.id] = res.round if res.is_submitted} if !responses.nil? && !responses.empty?
end

qData = ScoreView.find_by_sql ["SELECT q1_id,s_response_id, question_weight,s_score FROM score_views WHERE type in('Criterion', 'Scale') AND q1_id = ? AND s_response_id in (?)", questionnaire_id, assessments_by_team_id[team_id]]
scores[team_id] = {}
(1..@assignment.num_review_rounds).each{|idx| scores[team_id].merge!("#{idx}": [0, 0, 0, 0, 0, 0])} # [num0s,num1s,num2s,num3s,num4s,num5s]
qData.each do |qd|
if !qd.s_score.nil? && !res_round[qd.s_response_id].nil? # if res_round[qd.s_response_id].nil?, then not submitted
scores[team_id][res_round[qd.s_response_id].to_s.to_sym][qd.s_score] = scores[team_id][res_round[qd.s_response_id].to_s.to_sym][qd.s_score] + 1
end
end

scores[team_id]
end
</pre>

Additionally, there was JavaScript code added to the <code>_team_charts.html.erb</code> file. This code took the incoming <code>@scores</code> object and converted it to a format that the Flot libraries could understand. The JavaScript code also added the radio buttons to switch between the individual rounds and all rounds as well as the tooltip for the class performance visualizaton portion of this assignment.
<pre class="code">
function compileData() {
var allData = <%= @scores.to_json.html_safe %>;
var frequencyDataByTeam = collectFrequencyDataByTeam(allData);
var aggregate = calculateAggregateFrequencies(frequencyDataByTeam);
var data = convertAggregateFrequencyArraysToFlotData(aggregate);

return data;
}

function collectFrequencyDataByTeam(allData) {
var frequencyData = [];
for(var teamIdx in allData.teams) {
var team = allData.teams[teamIdx].team;
var scoresByRound = allData.teams[teamIdx].scores.scores_by_round;
frequencyData.push({
team: {
id: team.id,
name: team.name
},
scoresByRound: scoresByRound
});
}
return frequencyData;
}

function calculateAggregateFrequencies(frequencyData) {
var aggregate = aggregateByRound(frequencyData);

aggregate.all = aggregateAllRounds(aggregate);

return aggregate;
}

function aggregateAllRounds(aggregate) {
var all = [0,0,0,0,0,0];
for(var round in aggregate) {
for(var idx = 0;idx < aggregate[round].length;idx++) {
all[idx] += aggregate[round][idx];
}
}
return all;
}

function aggregateByRound(frequencyData) {
var aggregate = {};

for(var teamDataKey in frequencyData) {
var teamData = frequencyData[teamDataKey];
for(var round in teamData.scoresByRound) {
var scores = teamData.scoresByRound[round];
if(aggregate[round] == null) {
aggregate[round] = [0, 0, 0, 0, 0, 0];
}
for(var idx = 0;idx < scores.length;idx++) {
aggregate[round][idx] += scores[idx];
}
}
}

return aggregate;
}

function convertAggregateFrequencyArraysToFlotData(aggregate) {
var data = {};
for(var round in aggregate) {
data[round] = [];
for(var idx = 0;idx < aggregate[round].length;idx++) {
data[round].push([idx, aggregate[round][idx]]);
}
}

return data;
}

$("#class-performance-plot").width($("#class-performance-plot").parent().innerWidth()*0.8);
$("#class-performance-plot").height($("#team-chart").innerHeight());

$("#radioBtns").width($("#radioBtns").parent().innerWidth()*0.2);
$("#radioBtns").height($("#team-chart").innerHeight());

var cpdata = compileData();

var classPerformance = $.plot($("#class-performance-plot"),[cpdata.all],
{
grid: {
hoverable: true,
clickable: false
},series: {
lines: {
show: false,
fill: true,
steps: 0
},
bars: {
show: true,
align: 'center',
barWidth: 1
}
}
});

$("<div id='class-performance-plot-tooltip'></div>").css({
position: "absolute",
display: "none",
border: "1px solid #fdd",
padding: "2px",
"background-color": "#fee",
opacity: 0.80
}).appendTo("body");

$("#class-performance-plot").bind("plothover", function (event, pos, item) {

if (item) {
var x = item.datapoint[0],
y = item.datapoint[1];

$("#class-performance-plot-tooltip").html("Score: " + x + "; Frequency: " + y)
.css({top: item.pageY+5, left: item.pageX+5})
.fadeIn(200);
} else {
$("#class-performance-plot-tooltip").hide();
}

});

var radioBtn = $('<label><input type="radio" name="assignmentRound" value="all" checked onclick="showAggregation(\'all\')"/>All Rounds</label>')
radioBtn.appendTo('#radioBtns');

for (var round = 1; round <= <%= @assignment.num_review_rounds %>; round++) {
var radioBtn = $('<label><input type="radio" name="assignmentRound" onclick="showAggregation(\''+round+'\')"/>Round '+round+'</label>');
radioBtn.attr("value",round);
radioBtn.appendTo('#radioBtns');

}

window.showAggregation = function(round) {
classPerformance.setData([cpdata[round]]);
classPerformance.setupGrid();
classPerformance.draw();
}
</pre>

===Review Performance===
There some obsolete codes in review_mapping_helper.rb about Dr. Kidd's course. Those codes were intended to calculate author feedbacks of reviews and there are also some related codes in _review_report.html.erb. However, in the view part, those codes are commented and those do not work. In fact, Dr. Kidd's course is 806, which is not on Expertiza now. So those obsolete codes are removed. Since in the testing files there are no corresponding codes for those parts, the previous tests still work.
The new review table allows the instructor to sort the result by more options, like the number of reviews completed, the average volume and the average score. The page is given as below.

[[File:VirtualBox_Expertiza_Development_1_1_28_04_2018_23_24_38.png]]

==Testing Needed==

===Rubric Representation===
In terms of ensuring correct operation of the system under the changes made, our goal was to ensure the previous tests worked, as not much was entirely changed about the view controller method. Unfortunately we were unable to meet this goal, as integrating a test that could cover certain functionality without returning an error proved challenging. This is a possibility for a future team, or for future maintenance.

===Class Performance===
The tests verify that the correct frequency of raw scores is received from the database. A test is performed for rubric criteria that vary by round and one is created for an assignment where the rubric does not vary.

===Review Performance===
Some obsolete codes in the review_mapping_controller.rb are deleted and the previous test still works.

==Future Work==
One consideration to improve upon the work we have done, is to make it so that the visualization graph that shows participant performance on every rubric question in each round can handle assignments which vary the number of rubric questions between rounds. Currently the set-up does not support such a feature.

With regards to the class performance, an enhancement of showing the breakdown of weighted scores 0-100% could be shown instead of displaying the frequency of raw 0-5 scores. If it is decided to stay with using the raw scores, the frequency arrays should be made variable instead of returning a six-element array for scores 0-5 all the time. It would also be more useful to have a two-level breakdown of the radio button options, and thus the six-element frequency array data, for rounds then questions.

The remaining challenge is to integrate the author feedback to the review report page. It is hard because of multiple reasons. Some reviews have 3 rounds. The feedback of each round has multiple questions. Some are scored questions but some are not. In fact, even the author feedback report does not include the specific score.

== References ==
Here is our project [https://github.com/aspandit/expertiza repo] <br />
Here is our created [https://github.com/expertiza/expertiza/pull/1167 Pull Request] <br />
Here is our video [https://www.youtube.com/watch?v=nKu3LyFvm4M&feature=youtu.be Visualization for Instructors Walkthrough]

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-04T13:53:09Z

Aspandit: /* Implementation */

__TOC__

===Team Members===
Daniel Burcal (djburcal@ncsu.edu)

Patrick Poggi (pfpoggi@ncsu.edu)

Ambareesh Pandit (aspandit@ncsu.edu)

Minghao Pan (mpan2@ncsu.edu)

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

== Problem Statement ==

A previous team has worked on creating this visualization graphic for Instructors, which can be found [https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_pO9BX7iPGNe95o/edit# here]. We are tasked with building upon the work they have performed as well as improving the visualization aspect for instructors. Specifically we can narrow the goals of this project as follows:

:#The Visualization of the compiled metrics is confusing. We will aim to use a more coherent color scheme from red to green for the graph. We want to allow the instructor to dynamically generate graphs with the data they request. We will separate the table into partials or use a scheme to only show the sections of the table the instructor requests
:#There are ways to compile review data together such that it is even easier for the instructor to identify weaknesses and strengths. To that end, we would like to integrate review performance by compiling various feedback data that is collected. This would include the number of reviews performed, the length of the reviews, the summary of the reviews, whether or not the reviewers uploaded a file in their review, the average ratings the reviewers received from authors.
:#Another useful feature would be the ability to visualize class performance on a certain rubric criteria. Further, if these criteria are common ones used between projects, it would be very helpful to be able to compare performance between assignments on the common criteria.

== Design Process Flow ==

Below you can see a flowchart representing the graphical flow of an instructor visiting the visualization page we are modifying.

[[File:Final_Project_Graphic_Flow.jpg|center]]

Once the instructor visits the visualization page, they will already see a bar graph displaying how all the teams scored on each rubric criteria. Below this will be buttons or some other method by which to select the data that you want. The whole process flow involves being able to traverse the visualization page in a quick and efficient manner, since oftentimes the instructor will visit the page often. Below we will go into our intended design route for this project.

== Design ==

Here is a mock-up of our intended page:

[[File:Screen_Shot_2018-04-06_at_5.14.11_PM.png|center|]]

As you can see, we will have menu options by which the instructor can choose which data members to show and likewise the type of graphic visual they would like to produce. This will make it so that the instructors can visualize only the data they want to, and in the form that gives them the most relevant information. We plan on using the ''flot javascript library'' to implement the graphic visuals, which will provide an easy and clear visual of the requested data. Under the visual, we will have a way to select between teams and individual students' data to further target the desired visual. The last team which worked on this project used the ''highcharts javascript library'', but we have decided to move to ''flot'' due to visual clarity and the ability to easily decide which data to display.

Another mock-up of how the UI could be designed, is that by visiting the visualization page, the instructor will see a graph followed by an array of buttons.

[[File:ClassPerformanceStackedBarChartsWithToolTips.JPG‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/ap3ba5gu/90/ jsfiddle] </div>]]

The chart above shows stacked bar charts of a single submission. Each bar represents a question from the submission and the colors represent the percentage of teams that earned a 0(red) through 5(green) on the submission.

[[File:Final_Project_Buttons.jpg|center]]

As you can see, we plan on implementing an array of buttons to carry out simple manipulations to data and to display only the data the instructor wants to. We plan on implementing buttons to change the graphic that is displayed, so that if an instructor wishes to see a pie chart or histogram, they can click the button and see the data in a different form. Below those buttons, there will be other ones which will direct the page on what type of table to display and with which information. The reason for these adjustments are that in the last semester's implementation, the table was quite lengthy, and this will make it more manageable by the instructor.

It is possible that if we are able to, we plan on implementing a drop down functionality like in the mock-up further up the page where you can be even more selective about the data you wish to display in the tables or in the graphics.

==Modified Files==
Generally we plan on modifying the same files as the previous group did. The controllers of grade and assignment are involved. For the view part, we will modify the view of grade and review_mapping. We may also create new view files.
app/controllers/grades_controller.rb

app/controllers/assignments_controller.rb

app/views/grades/view.html.erb (partials below)

app/views/grades/_teams.html.erb

app/views/grades/_team_title.html.erb

app/views/grades/_team_charts.html.erb

app/view/review_mapping/_review_report.html.erb

== Testing Plan ==
Since it is based on a previous project, we need to refactor some previous code while making sure the previous test files ('''assignments_controller_spec.rb''' and '''grades_controller_spec.rb''') still work. We are going to test new features we add in the future.

It is beyond the scope of the course to test the graphs. We will only test the Ruby code.The tests will most likely use RSpec and the existing factories in Expertiza.

As we will use Javascript to achieve an interactive visualization, we will test the functionality of Javascript codes manually.

== Implementation ==

=== Visualization ===

In order to Improve the visualization of the rubric question data, we decided to use the flot javascript library instead of highcharts. In order to accomplish this, we constructed an adapter that took the already generate highchart data by the previous team, and converted it to a representation required by our flot graph. This is done in the highchart_to_flot_adapter method in the app/controllers/grades_controller.rb file.

==== Color Scheme ====

For fixing the color scheme, we used the adapter that was made to obtain the correct data, and instead of using their randomly generated colors, in the adapter there was a 6 element array with colors from red to green. This was inputted into the data series as per the correct format flot requires. You can also see the result below, in the picture of the graph provided.

==== Rubric Representation ====

To implement this, in the adapter we formed the data series such that different review rounds would be separated and clustered among their own review questions. This allows an easier viewing of different review rounds in order to determine how the class improved. The data passed to the _team_charts.html.erb view file contains all of the questions for all review rounds associated with the assignment. In addition to implementing the flot graphical representation, we also created a tooltip which allows the instructor to see the percentage of people who scored a certain value on any rubric questions of any round.

Here is a picture of what the completed flot graph looks like:

[[File:Visualization_graph_complete.JPG‎‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/twwprx9d/1/ jsfiddle] </div>]]

====Code====
The ruby code printed below is the adapter that was made to convert the highchart series data into the form required by our flot plot in the method highchart_to_flot_adapter.
<pre class="code">
def highchart_to_flot_adapter(min, max, highchart_series_data)
flot_series_data = []
flot_categories = []
highchart_data = []
flot_data = []
j = 0
k = 0
rounds = 0
highchart_series_index = 0
review_round = highchart_series_data.to_a.reverse[0][:stack]
flot_colors = ["#FF0000", "#FF6600", "#FFCC00", "#CCFF00", "#66FF00", "#00FF00"] # These are the six colors from red to green

# This loop will look at every element of the highchart_series_data and use them to form the flot_series_data
# and flot_categories. Flot_series_data is of the form [{data: [[0,x], [1,x], [2,x], [3,x], [4,x], ...], color: "#......"},...].
# It is an array of hashes of the size of the number of different scores, which for us is 6: 0, 1, 2, 3, 4, 5. The first
# value in each of those arrays within the hash indicates the specific question, while the x indicates the percentage
# of people which scored a certain score on that question. Flot_categories is a hash of the form [[0,""], [1,""], [2,""]],
# where the first value in each of the inner arrays indicates the question number and the quotes indicate the name
# of that question.
highchart_series_data.to_a.reverse.each do |element|
highchart_data = element[:data]
stack = element[:stack]
round = stack.scan(/[0-9]/)
# This tells flot_categories and flot_series_data that it is a new round
unless stack.eql?(review_round)
rounds += 1
review_round = stack
k = 0
end
# Every sixth element tells flot_categories to create as many ticks as there were questions in that round
if highchart_series_index % 6 == 1
for i in 0..highchart_data.size-1
flot_categories.push([k + (rounds*highchart_data.size), "Rubric \##{k} Round \##{round[0]}"])
k += 1
end
end
# Pushes the data into flot_series_data in the correct form specified above
for i in 0..highchart_data.size-1
if rounds > 0
flot_series_data[j][:data].push([i + (rounds*highchart_data.size), highchart_data[i]])
end
if rounds.zero?
flot_data.push([i, highchart_data[i]])
end
end
flot_series_data.push(data: flot_data, color: flot_colors[j]) if rounds.zero?

j += 1
if j > max
j = 0
end
flot_data = []
highchart_data = []
highchart_series_index += 1
end

# This loop calculates the percentages and stores them in the correct data series
num_reviewees = 0
for i in 0..flot_series_data[0][:data].size-1
for j in 0..flot_series_data.size - 1
num_reviewees += flot_series_data[j][:data][i][1]
end
for j in 0..flot_series_data.size - 1
unless num_reviewees.zero?
flot_series_data[j][:data][i][1] /= num_reviewees.to_f
flot_series_data[j][:data][i][1] *= 100.0
end
end
num_reviewees = 0
end
[flot_series_data, flot_categories]
end
</pre>

Also, javascript code was added in order to produce the stacked bar chart as shown on the webpage.
<pre class="code">
<div id="flot_scores_on_rubric_questions" style="width:1000px;height:300px;"> </div>

<script type="text/javascript">
$(function () {
$.plot($("#flot_scores_on_rubric_questions"), <%= @flot_series_data.to_json.html_safe %>, {
xaxis: {
ticks: <%= @flot_categories.to_json.html_safe %>
},
yaxis: {
tickFormatter: function(val, axis) { return val < axis.max ? val.toFixed(2) : "Percentage of teams";}
},
grid: {
hoverable: true,
clickable: true
},
series: {
stack: true,
lines: {
show: false,
fill: true,
steps: 0
},
bars: {
show: true,
align: 'center',
barWidth: 1
}
}
});

$("<div id='flot_team_scores_tooltip'></div>").css({
position: "absolute",
display: "none",
border: "1px solid #fdd",
padding: "2px",
"background-color": "#fee",
opacity: 0.80
}).appendTo("body");

$("#flot_scores_on_rubric_questions").bind("plothover", function (event, pos, item) {

if (item) {
var x = item.datapoint[0],
y = item.datapoint[1];

$("#flot_team_scores_tooltip").html(item.series.xaxis.ticks[x].label + ": " + item.series.data[x][1].toFixed(2) + "% of the class scored " + item.seriesIndex)
.css({top: item.pageY+5, left: item.pageX+5})
.fadeIn(200);
} else {
$("#flot_team_scores_tooltip").hide();
}
});
</pre>

===Class Performance===
The Class Performance visualization allows the instructor to view a histogram of 0 to 5 scores for a particular assignment. Furthermore, the visualization allows the user to switch between the preliminary round and the final round as well as view a combined view. As with the rubric criteria visualization, hovering over a bar in the class performance visualization brings up a tooltip indicating the score and frequency of teams that earned that score.

[[File:Class_performance_graph.JPG‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/w17tdby1/1/ jsfiddle] </div>]]

====Code====
The ruby code added is below. These are additional methods in the grades controller that collects and adds the raw score counts for each team to the <code>@scores</code> instance variable
<pre class="code">
def add_scores_by_round
scores_by_team_round = get_raw_scores_by_team_round(@questions)
@scores[:teams].each_value do |value|
team_id = value[:team][:id]
value[:scores][:scores_by_round] = scores_by_team_round[:teams][team_id]
end
end

def get_raw_scores_by_team_round(questions)
scores = {}

scores[:teams] = {}
if !questions.nil? && !questions.empty?
@assignment.teams.collect {|team| team.id}.each do |team_id|
first_round_sym = (@assignment.num_review_rounds == 1) ? :review : :review1
scores[:teams][team_id] = get_team_raw_scores_by_round(team_id,questions[first_round_sym][0].questionnaire.id) if !questions[first_round_sym].nil? && !questions[first_round_sym].empty?
end
end
scores
end

def get_team_raw_scores_by_round(team_id, questionnaire_id)
scores = {}
maps = ResponseMap.where(reviewee_id: team_id, type: "ReviewResponseMap")
assessments_by_team_id = {}
res_round = {}
maps.each do |m|
responses = m.response.each{|r| r.response_id} # response_id is the actual response here
assessments_by_team_id[team_id] = [] if assessments_by_team_id[team_id].nil?
responses.each{|res| assessments_by_team_id[team_id] << res.id if res.is_submitted} if !responses.nil? && !responses.empty?
responses.each{|res| res_round[res.id] = res.round if res.is_submitted} if !responses.nil? && !responses.empty?
end

qData = ScoreView.find_by_sql ["SELECT q1_id,s_response_id, question_weight,s_score FROM score_views WHERE type in('Criterion', 'Scale') AND q1_id = ? AND s_response_id in (?)", questionnaire_id, assessments_by_team_id[team_id]]
scores[team_id] = {}
(1..@assignment.num_review_rounds).each{|idx| scores[team_id].merge!("#{idx}": [0, 0, 0, 0, 0, 0])} # [num0s,num1s,num2s,num3s,num4s,num5s]
qData.each do |qd|
if !qd.s_score.nil? && !res_round[qd.s_response_id].nil? # if res_round[qd.s_response_id].nil?, then not submitted
scores[team_id][res_round[qd.s_response_id].to_s.to_sym][qd.s_score] = scores[team_id][res_round[qd.s_response_id].to_s.to_sym][qd.s_score] + 1
end
end

scores[team_id]
end
</pre>

Additionally, there was JavaScript code added to the <code>_team_charts.html.erb</code> file. This code took the incoming <code>@scores</code> object and converted it to a format that the Flot libraries could understand. The JavaScript code also added the radio buttons to switch between the individual rounds and all rounds as well as the tooltip for the class performance visualizaton portion of this assignment.
<pre class="code">
function compileData() {
var allData = <%= @scores.to_json.html_safe %>;
var frequencyDataByTeam = collectFrequencyDataByTeam(allData);
var aggregate = calculateAggregateFrequencies(frequencyDataByTeam);
var data = convertAggregateFrequencyArraysToFlotData(aggregate);

return data;
}

function collectFrequencyDataByTeam(allData) {
var frequencyData = [];
for(var teamIdx in allData.teams) {
var team = allData.teams[teamIdx].team;
var scoresByRound = allData.teams[teamIdx].scores.scores_by_round;
frequencyData.push({
team: {
id: team.id,
name: team.name
},
scoresByRound: scoresByRound
});
}
return frequencyData;
}

function calculateAggregateFrequencies(frequencyData) {
var aggregate = aggregateByRound(frequencyData);

aggregate.all = aggregateAllRounds(aggregate);

return aggregate;
}

function aggregateAllRounds(aggregate) {
var all = [0,0,0,0,0,0];
for(var round in aggregate) {
for(var idx = 0;idx < aggregate[round].length;idx++) {
all[idx] += aggregate[round][idx];
}
}
return all;
}

function aggregateByRound(frequencyData) {
var aggregate = {};

for(var teamDataKey in frequencyData) {
var teamData = frequencyData[teamDataKey];
for(var round in teamData.scoresByRound) {
var scores = teamData.scoresByRound[round];
if(aggregate[round] == null) {
aggregate[round] = [0, 0, 0, 0, 0, 0];
}
for(var idx = 0;idx < scores.length;idx++) {
aggregate[round][idx] += scores[idx];
}
}
}

return aggregate;
}

function convertAggregateFrequencyArraysToFlotData(aggregate) {
var data = {};
for(var round in aggregate) {
data[round] = [];
for(var idx = 0;idx < aggregate[round].length;idx++) {
data[round].push([idx, aggregate[round][idx]]);
}
}

return data;
}

$("#class-performance-plot").width($("#class-performance-plot").parent().innerWidth()*0.8);
$("#class-performance-plot").height($("#team-chart").innerHeight());

$("#radioBtns").width($("#radioBtns").parent().innerWidth()*0.2);
$("#radioBtns").height($("#team-chart").innerHeight());

var cpdata = compileData();

var classPerformance = $.plot($("#class-performance-plot"),[cpdata.all],
{
grid: {
hoverable: true,
clickable: false
},series: {
lines: {
show: false,
fill: true,
steps: 0
},
bars: {
show: true,
align: 'center',
barWidth: 1
}
}
});

$("<div id='class-performance-plot-tooltip'></div>").css({
position: "absolute",
display: "none",
border: "1px solid #fdd",
padding: "2px",
"background-color": "#fee",
opacity: 0.80
}).appendTo("body");

$("#class-performance-plot").bind("plothover", function (event, pos, item) {

if (item) {
var x = item.datapoint[0],
y = item.datapoint[1];

$("#class-performance-plot-tooltip").html("Score: " + x + "; Frequency: " + y)
.css({top: item.pageY+5, left: item.pageX+5})
.fadeIn(200);
} else {
$("#class-performance-plot-tooltip").hide();
}

});

var radioBtn = $('<label><input type="radio" name="assignmentRound" value="all" checked onclick="showAggregation(\'all\')"/>All Rounds</label>')
radioBtn.appendTo('#radioBtns');

for (var round = 1; round <= <%= @assignment.num_review_rounds %>; round++) {
var radioBtn = $('<label><input type="radio" name="assignmentRound" onclick="showAggregation(\''+round+'\')"/>Round '+round+'</label>');
radioBtn.attr("value",round);
radioBtn.appendTo('#radioBtns');

}

window.showAggregation = function(round) {
classPerformance.setData([cpdata[round]]);
classPerformance.setupGrid();
classPerformance.draw();
}
</pre>

===Review Performance===
There some obsolete codes in review_mapping_helper.rb about Dr. Kidd's course. Those codes were intended to calculate author feedbacks of reviews and there are also some related codes in _review_report.html.erb. However, in the view part, those codes are commented and those do not work. In fact, Dr. Kidd's course is 806, which is not on Expertiza now. So those obsolete codes are removed. Since in the testing files there are no corresponding codes for those parts, the previous tests still work.
The new review table allows the instructor to sort the result by more options, like the number of reviews completed, the average volume and the average score. The page is given as below.

[[File:VirtualBox_Expertiza_Development_1_1_28_04_2018_23_24_38.png]]

==Testing Needed==

===Rubric Representation===
In terms of ensuring correct operation of the system under the changes made, our goal was to ensure the previous tests worked, as not much was entirely changed about the view controller method. Unfortunately we were unable to meet this goal, as integrating a test that could cover certain functionality without returning an error proved challenging. This is a possibility for a future team, or for future maintenance.

===Class Performance===
The tests verify that the correct frequency of raw scores is received from the database. A test is performed for rubric criteria that vary by round and one is created for an assignment where the rubric does not vary.

===Review Performance===
Some obsolete codes in the review_mapping_controller.rb are deleted and the previous test still works.

==Future Work==
One consideration to improve upon the work we have done, is to make it so that the visualization graph that shows participant performance on every rubric question in each round can handle assignments which vary the number of rubric questions between rounds. Currently the set-up does not support such a feature.

With regards to the class performance, an enhancement of showing the breakdown of weighted scores 0-100% could be shown instead of displaying the frequency of raw 0-5 scores.

The remaining challenge is to integrate the author feedback to the review report page. It is hard because of multiple reasons. Some reviews have 3 rounds. The feedback of each round has multiple questions. Some are scored questions but some are not. In fact, even the author feedback report does not include the specific score.

== References ==
Here is our project [https://github.com/aspandit/expertiza repo] <br />
Here is our created [https://github.com/expertiza/expertiza/pull/1167 Pull Request] <br />
Here is our video [https://www.youtube.com/watch?v=nKu3LyFvm4M&feature=youtu.be Visualization for Instructors Walkthrough]

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-04T10:15:48Z

Aspandit: /* Class Performance */

__TOC__

===Team Members===
Daniel Burcal (djburcal@ncsu.edu)

Patrick Poggi (pfpoggi@ncsu.edu)

Ambareesh Pandit (aspandit@ncsu.edu)

Minghao Pan (mpan2@ncsu.edu)

==Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is an open source web application based on [http://rubyonrails.org/ Ruby on Rails] framework, supported by the National Science Foundation.
It is a place where students can submit and peer-review learning objects (assignments, codes, write ups, websites, etc). For an instructor, expertiza allows to create and customize new or existing assignments. For students, it allows to create and work on various projects and assignments. It provides a platform to peer review other students' submissions across various document types, including the URLs and wiki pages.

== Problem Statement ==

A previous team has worked on creating this visualization graphic for Instructors, which can be found [https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_pO9BX7iPGNe95o/edit# here]. We are tasked with building upon the work they have performed as well as improving the visualization aspect for instructors. Specifically we can narrow the goals of this project as follows:

:#The Visualization of the compiled metrics is confusing. We will aim to use a more coherent color scheme from red to green for the graph. We want to allow the instructor to dynamically generate graphs with the data they request. We will separate the table into partials or use a scheme to only show the sections of the table the instructor requests
:#There are ways to compile review data together such that it is even easier for the instructor to identify weaknesses and strengths. To that end, we would like to integrate review performance by compiling various feedback data that is collected. This would include the number of reviews performed, the length of the reviews, the summary of the reviews, whether or not the reviewers uploaded a file in their review, the average ratings the reviewers received from authors.
:#Another useful feature would be the ability to visualize class performance on a certain rubric criteria. Further, if these criteria are common ones used between projects, it would be very helpful to be able to compare performance between assignments on the common criteria.

== Design Process Flow ==

Below you can see a flowchart representing the graphical flow of an instructor visiting the visualization page we are modifying.

[[File:Final_Project_Graphic_Flow.jpg|center]]

Once the instructor visits the visualization page, they will already see a bar graph displaying how all the teams scored on each rubric criteria. Below this will be buttons or some other method by which to select the data that you want. The whole process flow involves being able to traverse the visualization page in a quick and efficient manner, since oftentimes the instructor will visit the page often. Below we will go into our intended design route for this project.

== Design ==

Here is a mock-up of our intended page:

[[File:Screen_Shot_2018-04-06_at_5.14.11_PM.png|center|]]

As you can see, we will have menu options by which the instructor can choose which data members to show and likewise the type of graphic visual they would like to produce. This will make it so that the instructors can visualize only the data they want to, and in the form that gives them the most relevant information. We plan on using the ''flot javascript library'' to implement the graphic visuals, which will provide an easy and clear visual of the requested data. Under the visual, we will have a way to select between teams and individual students' data to further target the desired visual. The last team which worked on this project used the ''highcharts javascript library'', but we have decided to move to ''flot'' due to visual clarity and the ability to easily decide which data to display.

Another mock-up of how the UI could be designed, is that by visiting the visualization page, the instructor will see a graph followed by an array of buttons.

[[File:ClassPerformanceStackedBarChartsWithToolTips.JPG‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/ap3ba5gu/90/ jsfiddle] </div>]]

The chart above shows stacked bar charts of a single submission. Each bar represents a question from the submission and the colors represent the percentage of teams that earned a 0(red) through 5(green) on the submission.

[[File:Final_Project_Buttons.jpg|center]]

As you can see, we plan on implementing an array of buttons to carry out simple manipulations to data and to display only the data the instructor wants to. We plan on implementing buttons to change the graphic that is displayed, so that if an instructor wishes to see a pie chart or histogram, they can click the button and see the data in a different form. Below those buttons, there will be other ones which will direct the page on what type of table to display and with which information. The reason for these adjustments are that in the last semester's implementation, the table was quite lengthy, and this will make it more manageable by the instructor.

It is possible that if we are able to, we plan on implementing a drop down functionality like in the mock-up further up the page where you can be even more selective about the data you wish to display in the tables or in the graphics.

==Modified Files==
Generally we plan on modifying the same files as the previous group did. The controllers of grade and assignment are involved. For the view part, we will modify the view of grade and review_mapping. We may also create new view files.
app/controllers/grades_controller.rb

app/controllers/assignments_controller.rb

app/views/grades/view.html.erb (partials below)

app/views/grades/_teams.html.erb

app/views/grades/_team_title.html.erb

app/views/grades/_team_charts.html.erb

app/view/review_mapping/_review_report.html.erb

== Testing Plan ==
Since it is based on a previous project, we need to refactor some previous code while making sure the previous test files ('''assignments_controller_spec.rb''' and '''grades_controller_spec.rb''') still work. We are going to test new features we add in the future.

It is beyond the scope of the course to test the graphs. We will only test the Ruby code.The tests will most likely use RSpec and the existing factories in Expertiza.

As we will use Javascript to achieve an interactive visualization, we will test the functionality of Javascript codes manually.

== Implementation ==

=== Visualization ===

In order to Improve the visualization of the rubric question data, we decided to use the flot javascript library instead of highcharts. In order to accomplish this, we constructed an adapter that took the already generate highchart data by the previous team, and converted it to a representation required by our flot graph. This is done in the highchart_to_flot_adapter method in the app/controllers/grades_controller.rb file.

==== Color Scheme ====

For fixing the color scheme, we used the adapter that was made to obtain the correct data, and instead of using their randomly generated colors, in the adapter there was a 6 element array with colors from red to green. This was inputted into the data series as per the correct format flot requires. You can also see the result below, in the picture of the graph provided.

==== Rubric Representation ====

To implement this, in the adapter we formed the data series such that different review rounds would be separated and clustered among their own review questions. This allows an easier viewing of different review rounds in order to determine how the class improved. The data passed to the _team_charts.html.erb view file contains all of the questions for all review rounds associated with the assignment. In addition to implementing the flot graphical representation, we also created a tooltip which allows the instructor to see the percentage of people who scored a certain value on any rubric questions of any round.

Here is a picture of what the completed flot graph looks like:

[[File:Visualization_graph_complete.JPG‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/twwprx9d/1/ jsfiddle] </div>]]

===Class Performance===
The Class Performance visualization allows the instructor to view a histogram of 0 to 5 scores for a particular assignment. Furthermore, the visualization allows the user to switch between the preliminary round and the final round as well as view a combined view. As with the rubric criteria visualization, hovering over a bar in the class performance visualization brings up a tooltip indicating the score and frequency of teams that earned that score.

[[File:Class_performance_graph.JPG‎|frame|center|alt=Stacked Bar|<div style="text-align: center">The source for this graph is at [https://jsfiddle.net/aspandit/w17tdby1/1/ jsfiddle] </div>]]

====Code====
The ruby code added is below. These are additional methods in the grades controller that collects and adds the raw score counts for each team to the <code>@scores</code> instance variable
<pre class="code">
def add_scores_by_round
scores_by_team_round = get_raw_scores_by_team_round(@questions)
@scores[:teams].each_value do |value|
team_id = value[:team][:id]
value[:scores][:scores_by_round] = scores_by_team_round[:teams][team_id]
end
end

def get_raw_scores_by_team_round(questions)
scores = {}

scores[:teams] = {}
if !questions.nil? && !questions.empty?
@assignment.teams.collect {|team| team.id}.each do |team_id|
first_round_sym = (@assignment.num_review_rounds == 1) ? :review : :review1
scores[:teams][team_id] = get_team_raw_scores_by_round(team_id,questions[first_round_sym][0].questionnaire.id) if !questions[first_round_sym].nil? && !questions[first_round_sym].empty?
end
end
scores
end

def get_team_raw_scores_by_round(team_id, questionnaire_id)
scores = {}
maps = ResponseMap.where(reviewee_id: team_id, type: "ReviewResponseMap")
assessments_by_team_id = {}
res_round = {}
maps.each do |m|
responses = m.response.each{|r| r.response_id} # response_id is the actual response here
assessments_by_team_id[team_id] = [] if assessments_by_team_id[team_id].nil?
responses.each{|res| assessments_by_team_id[team_id] << res.id if res.is_submitted} if !responses.nil? && !responses.empty?
responses.each{|res| res_round[res.id] = res.round if res.is_submitted} if !responses.nil? && !responses.empty?
end

qData = ScoreView.find_by_sql ["SELECT q1_id,s_response_id, question_weight,s_score FROM score_views WHERE type in('Criterion', 'Scale') AND q1_id = ? AND s_response_id in (?)", questionnaire_id, assessments_by_team_id[team_id]]
scores[team_id] = {}
(1..@assignment.num_review_rounds).each{|idx| scores[team_id].merge!("#{idx}": [0, 0, 0, 0, 0, 0])} # [num0s,num1s,num2s,num3s,num4s,num5s]
qData.each do |qd|
if !qd.s_score.nil? && !res_round[qd.s_response_id].nil? # if res_round[qd.s_response_id].nil?, then not submitted
scores[team_id][res_round[qd.s_response_id].to_s.to_sym][qd.s_score] = scores[team_id][res_round[qd.s_response_id].to_s.to_sym][qd.s_score] + 1
end
end

scores[team_id]
end
</pre>

Additionally, there was JavaScript code added to the <code>_team_charts.html.erb</code> file. This code took the incoming <code>@scores</code> object and converted it to a format that the Flot libraries could understand. The JavaScript code also added the radio buttons to switch between the individual rounds and all rounds as well as the tooltip for the class performance visualizaton portion of this assignment.
<pre class="code">
function compileData() {
var allData = <%= @scores.to_json.html_safe %>;
var frequencyDataByTeam = collectFrequencyDataByTeam(allData);
var aggregate = calculateAggregateFrequencies(frequencyDataByTeam);
var data = convertAggregateFrequencyArraysToFlotData(aggregate);

return data;
}

function collectFrequencyDataByTeam(allData) {
var frequencyData = [];
for(var teamIdx in allData.teams) {
var team = allData.teams[teamIdx].team;
var scoresByRound = allData.teams[teamIdx].scores.scores_by_round;
frequencyData.push({
team: {
id: team.id,
name: team.name
},
scoresByRound: scoresByRound
});
}
return frequencyData;
}

function calculateAggregateFrequencies(frequencyData) {
var aggregate = aggregateByRound(frequencyData);

aggregate.all = aggregateAllRounds(aggregate);

return aggregate;
}

function aggregateAllRounds(aggregate) {
var all = [0,0,0,0,0,0];
for(var round in aggregate) {
for(var idx = 0;idx < aggregate[round].length;idx++) {
all[idx] += aggregate[round][idx];
}
}
return all;
}

function aggregateByRound(frequencyData) {
var aggregate = {};

for(var teamDataKey in frequencyData) {
var teamData = frequencyData[teamDataKey];
for(var round in teamData.scoresByRound) {
var scores = teamData.scoresByRound[round];
if(aggregate[round] == null) {
aggregate[round] = [0, 0, 0, 0, 0, 0];
}
for(var idx = 0;idx < scores.length;idx++) {
aggregate[round][idx] += scores[idx];
}
}
}

return aggregate;
}

function convertAggregateFrequencyArraysToFlotData(aggregate) {
var data = {};
for(var round in aggregate) {
data[round] = [];
for(var idx = 0;idx < aggregate[round].length;idx++) {
data[round].push([idx, aggregate[round][idx]]);
}
}

return data;
}

$("#class-performance-plot").width($("#class-performance-plot").parent().innerWidth()*0.8);
$("#class-performance-plot").height($("#team-chart").innerHeight());

$("#radioBtns").width($("#radioBtns").parent().innerWidth()*0.2);
$("#radioBtns").height($("#team-chart").innerHeight());

var cpdata = compileData();

var classPerformance = $.plot($("#class-performance-plot"),[cpdata.all],
{
grid: {
hoverable: true,
clickable: false
},series: {
lines: {
show: false,
fill: true,
steps: 0
},
bars: {
show: true,
align: 'center',
barWidth: 1
}
}
});

$("<div id='class-performance-plot-tooltip'></div>").css({
position: "absolute",
display: "none",
border: "1px solid #fdd",
padding: "2px",
"background-color": "#fee",
opacity: 0.80
}).appendTo("body");

$("#class-performance-plot").bind("plothover", function (event, pos, item) {

if (item) {
var x = item.datapoint[0],
y = item.datapoint[1];

$("#class-performance-plot-tooltip").html("Score: " + x + "; Frequency: " + y)
.css({top: item.pageY+5, left: item.pageX+5})
.fadeIn(200);
} else {
$("#class-performance-plot-tooltip").hide();
}

});

var radioBtn = $('<label><input type="radio" name="assignmentRound" value="all" checked onclick="showAggregation(\'all\')"/>All Rounds</label>')
radioBtn.appendTo('#radioBtns');

for (var round = 1; round <= <%= @assignment.num_review_rounds %>; round++) {
var radioBtn = $('<label><input type="radio" name="assignmentRound" onclick="showAggregation(\''+round+'\')"/>Round '+round+'</label>');
radioBtn.attr("value",round);
radioBtn.appendTo('#radioBtns');

}

window.showAggregation = function(round) {
classPerformance.setData([cpdata[round]]);
classPerformance.setupGrid();
classPerformance.draw();
}
</pre>

===Review Performance===
There some obsolete codes in review_mapping_helper.rb about Dr. Kidd's course. Those codes were intended to calculate author feedbacks of reviews and there are also some related codes in _review_report.html.erb. However, in the view part, those codes are commented and those do not work. In fact, Dr. Kidd's course is 806, which is not on Expertiza now. So those obsolete codes are removed. Since in the testing files there are no corresponding codes for those parts, the previous tests still work.
The new review table allows the instructor to sort the result by more options, like the number of reviews completed, the average volume and the average score. The page is given as below.

[[File:VirtualBox_Expertiza_Development_1_1_28_04_2018_23_24_38.png]]

==Testing Done==

===Rubric Representation===
In terms of ensuring correct operation of the system under the changes made, our goal was to ensure the previous tests worked, as not much was entirely changed about the view controller method. In ensuring the previous tests worked, we could then be sure the private methods within the grades_controller.rb file were working properly.

===Class Performance===
The tests verify that the correct frequency of raw scores is received from the database. A test is performed for rubric criteria that vary by round and one is created for an assignment where the rubric does not vary.

===Review Performance===
Some obsolete codes in the review_mapping_controller.rb are deleted and the previous test still works.

==Future Work==
One consideration to improve upon the work we have done, is to make it so that the visualization graph that shows participant performance on every rubric question in each round can handle assignments which vary the number of rubric questions between rounds. Currently the set-up does not support such a feature.

With regards to the class performance, an enhancement of showing the breakdown of weighted scores 0-100% could be shown instead of displaying the frequency of raw 0-5 scores.

The remaining challenge is to integrate the author feedback to the review report page. It is hard because of multiple reasons. Some reviews have 3 rounds. The feedback of each round has multiple questions. Some are scored questions but some are not. In fact, even the author feedback report does not include the specific score.

== References ==
Here is our project [https://github.com/aspandit/expertiza repo] <br />
Here is our created [https://github.com/expertiza/expertiza/pull/1167 Pull Request] <br />
Here is our video [https://www.youtube.com/watch?v=nKu3LyFvm4M&feature=youtu.be Visualization for Instructors Walkthrough]

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-04T04:19:38Z

Aspandit: /* Class Performance */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-04T04:10:39Z

Aspandit: /* Rubric Representation */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-04T04:08:59Z

Aspandit: /* Rubric Representation */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-03T23:04:37Z

Aspandit: /* Class Performance */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-03T23:00:19Z

Aspandit: /* Future Work */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-05-03T22:57:05Z

Aspandit: /* Class Performance */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-04-29T03:32:55Z

Aspandit: /* Class Performance */

File:ClassPerformanceStackedBarChartsWithToolTips.JPG

2018-04-23T02:36:24Z

Aspandit: uploaded a new version of "File:ClassPerformanceStackedBarChartsWithToolTips.JPG"

File:ClassPerformanceStackedBarChartsWithToolTips.JPG

2018-04-23T02:34:03Z

Aspandit: uploaded a new version of "File:ClassPerformanceStackedBarChartsWithToolTips.JPG"

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-04-23T02:32:51Z

Aspandit: /* Design */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-04-14T21:21:13Z

Aspandit: /* Design */

File:ClassPerformanceStackedBarChartsWithToolTips.JPG

2018-04-14T21:20:14Z

Aspandit: uploaded a new version of "File:ClassPerformanceStackedBarChartsWithToolTips.JPG"

File:ClassPerformanceStackedBarChartsWithToolTips.JPG

2018-04-14T21:16:03Z

Aspandit:

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-04-14T21:15:21Z

Aspandit: /* Design */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-04-14T03:09:26Z

Aspandit: /* Design */

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-04-08T23:22:54Z

Aspandit: /* References */

__TOC__

===Team Members===
Daniel Burcal (djburcal@ncsu.edu)

Patrick Poggi (pfpoggi@ncsu.edu)

Ambareesh Pandit (aspandit@ncsu.edu)

Minghao Pan (mpan2@ncsu.edu)

== Problem Statement ==

A previous team has worked on creating this visualization graphic for Instructors, which can be found [https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_pO9BX7iPGNe95o/edit# here]. We are tasked with building upon the work they have performed as well as improving the visualization aspect for instructors. Specifically we can narrow the goals of this project as follows:

:#The Visualization of the compiled metrics is confusing. We will aim to use a more coherent color scheme from red to green for the graph. We want to allow the instructor to dynamically generate graphs with the data they request. We will separate the table into partials or use a scheme to only show the sections of the table the instructor requests
:#There are ways to compile review data together such that it is even easier for the instructor to identify weaknesses and strengths. To that end, we would like to integrate review performance by compiling various feedback data that is collected. This would include the number of reviews performed, the length of the reviews, the summary of the reviews, whether or not the reviewers uploaded a file in their review, the average ratings the reviewers received from authors.
:#Another useful feature would be the ability to visualize class performance on a certain rubric criteria. Further, if these criteria are common ones used between projects, it would be very helpful to be able to compare performance between assignments on the common criteria.

== Preliminary Design ==

A mock-up of our potential implementation of the graphic visual may be seen below.

[[File:Screen_Shot_2018-04-06_at_5.14.11_PM.png]]

As you can see, we will have menu options by which the instructor can choose which data members to show and likewise the type of graphic visual they would like to produce. This will make it so that the instructors can visualize only the data they want to, and in the form that gives them the most relevant information. We plan on using the ''highcharts javascript library'' to implement the graphic visuals, which will provide an easy and clear visual of the requested data. Under the visual, we will have a way to select between teams and individual students' data to further target the desired visual.

As denoted in the problem statement, we will also address the table of review data. Currently it is overwhelming and we would like to simplify it by maintaining the ability to inspect the data. We will devise a method to sort the table contents and to only display what is requested.

== References ==
Here is our project [https://github.com/aspandit/expertiza repo] <br />
Here is our created [https://github.com/expertiza/expertiza/pull/1167 Pull Request]

CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors

2018-04-07T05:48:53Z

Aspandit: /* Preliminary Design */

__TOC__

===Team Members===
Daniel Burcal (djburcal@ncsu.edu)

Patrick Francisco Poggi (pfpoggi@ncsu.edu)

Ambareesh Pandit (aspandit@ncsu.edu)

Minghao Pan (mpan2@ncsu.edu)

== Problem Statement ==

A previous team has worked on creating this visualization graphic for Instructors, which can be found [https://docs.google.com/document/d/1ybg9CK03_j3QtLI9R6vJqYunz8_I_pO9BX7iPGNe95o/edit# here]. We are tasked with building upon the work they have performed as well as improving the visualization aspect for instructors. Specifically we can narrow the goals of this project as follows:

:#The Visualization of the compiled metrics is confusing. We will aim to use a more coherent color scheme from red to green for the graph. We want to allow the instructor to dynamically generate graphs with the data they request. We will separate the table into partials or use a scheme to only show the sections of the table the instructor requests
:#There are ways to compile review data together such that it is even easier for the instructor to identify weaknesses and strengths. To that end, we would like to integrate review performance by compiling various feedback data that is collected. This would include the number of reviews performed, the length of the reviews, the summary of the reviews, whether or not the reviewers uploaded a file in their review, the average ratings the reviewers received from authors.
:#Another useful feature would be the ability to visualize class performance on a certain rubric criteria. Further, if these criteria are common ones used between projects, it would be very helpful to be able to compare performance between assignments on the common criteria.

== Preliminary Design ==

A mock-up of our potential implementation of the graphic visual may be seen below.

[[File:Screen_Shot_2018-04-06_at_5.14.11_PM.png]]

As you can see, we will have menu options by which the instructor can choose which data members to show and likewise the type of graphic visual they would like to produce. This will make it so that the instructors can visualize only the data they want to, and in the form that gives them the most relevant information. We plan on using the ''highcharts javascript library'' to implement the graphic visuals, which will provide an easy and clear visual of the requested data. Under the visual, we will have a way to select between teams and individual students' data to further target the desired visual.

As denoted in the problem statement, we will also address the table of review data. Currently it is overwhelming and we would like to simplify it by maintaining the ability to inspect the data. We will devise a method to sort the table contents and to only display what is requested.

File:StudentAssignmentsList.jpg

2018-04-03T04:17:48Z

Aspandit:

File:AssignmentMenu.jpg

2018-04-03T04:17:14Z

Aspandit:

File:SignupSheet.jpg

2018-04-03T04:16:55Z

Aspandit:

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T04:16:24Z

Aspandit: /* Sign up for a topic as a student */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#:[[File:ToBeDeleted.jpg]]
#Note that the topic is no longer in the table.
#:[[File:DeletedTopic.jpg]]

===== '''Edit topic''' =====
To edit a topic to an assignment,
#Select the [[File:editButton.jpg]] on the desired topic of the unfinished assignment that was navigated to in the first section.
#In the subsequent Edit Dialog, make the desired edits and click Save.
#:[[File:EditDialog.jpg]]
#The newly editted topic will appear with the new value(s).
#:[[File:NewlyEdittedTopic.jpg]]

===== '''Navigate to finished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "OSS project/Writing assignment 2" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:FinishedAssignmentsTabs.JPG]]
#Note the unavailable actions(add,edit,delete) and bookmarks absent for each unfinished topics.
#:[[File:FinishedAssignmentTopicsTab.JPG]]

===== '''Sign up for a topic as a student''' =====
#Log in as "student5918" with the password "password" at < https://vast-bastion-53966.herokuapp.com >.
#Select "Final Project (and Design Document)" from the assignments list.
#:[[File:StudentAssignmentsList.jpg]]
#Select "Signup sheet" from the assignment menu.
#:[[File:AssignmentMenu.jpg]]
#Select the check icon next to the desired topic.
#:[[File:SignupSheet.jpg]]

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T04:16:09Z

Aspandit: /* Sign up for a topic as a student */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#:[[File:ToBeDeleted.jpg]]
#Note that the topic is no longer in the table.
#:[[File:DeletedTopic.jpg]]

===== '''Edit topic''' =====
To edit a topic to an assignment,
#Select the [[File:editButton.jpg]] on the desired topic of the unfinished assignment that was navigated to in the first section.
#In the subsequent Edit Dialog, make the desired edits and click Save.
#:[[File:EditDialog.jpg]]
#The newly editted topic will appear with the new value(s).
#:[[File:NewlyEdittedTopic.jpg]]

===== '''Navigate to finished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "OSS project/Writing assignment 2" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:FinishedAssignmentsTabs.JPG]]
#Note the unavailable actions(add,edit,delete) and bookmarks absent for each unfinished topics.
#:[[File:FinishedAssignmentTopicsTab.JPG]]

===== '''Sign up for a topic as a student''' =====
#Log in as "student5918" with the password "password" at < https://vast-bastion-53966.herokuapp.com >.
#Select "Final Project (and Design Document)" from the assignments list.
#:[[File:StudentAssignmentsList.jpg]]
#Select "Signup sheet" from the assignment menu.
#:[[File:AssignmentMenu.jpg]]
#Select the check icon next to the desired topic.
#:[File:SignupSheet.jpg]

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

File:FinishedAssignmentsTabs.JPG

2018-04-03T04:10:11Z

Aspandit:

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T04:09:59Z

Aspandit: /* Navigate to finished assignment */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#:[[File:ToBeDeleted.jpg]]
#Note that the topic is no longer in the table.
#:[[File:DeletedTopic.jpg]]

===== '''Edit topic''' =====
To edit a topic to an assignment,
#Select the [[File:editButton.jpg]] on the desired topic of the unfinished assignment that was navigated to in the first section.
#In the subsequent Edit Dialog, make the desired edits and click Save.
#:[[File:EditDialog.jpg]]
#The newly editted topic will appear with the new value(s).
#:[[File:NewlyEdittedTopic.jpg]]

===== '''Navigate to finished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "OSS project/Writing assignment 2" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:FinishedAssignmentsTabs.JPG]]
#Note the unavailable actions(add,edit,delete) and bookmarks absent for each unfinished topics.
#:[[File:FinishedAssignmentTopicsTab.JPG]]

===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

File:FinishedAssignmentTopicsTab.JPG

2018-04-03T04:08:59Z

Aspandit:

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T04:08:28Z

Aspandit: /* Navigate to finished assignment */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#:[[File:ToBeDeleted.jpg]]
#Note that the topic is no longer in the table.
#:[[File:DeletedTopic.jpg]]

===== '''Edit topic''' =====
To edit a topic to an assignment,
#Select the [[File:editButton.jpg]] on the desired topic of the unfinished assignment that was navigated to in the first section.
#In the subsequent Edit Dialog, make the desired edits and click Save.
#:[[File:EditDialog.jpg]]
#The newly editted topic will appear with the new value(s).
#:[[File:NewlyEdittedTopic.jpg]]

===== '''Navigate to finished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "OSS project/Writing assignment 2" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the unavailable actions(add,edit,delete) and bookmarks absent for each unfinished topics.
#:[[File:FinishedAssignmentTopicsTab.JPG]]

===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

File:NewlyEdittedTopic.jpg

2018-04-03T04:02:45Z

Aspandit:

File:EditDialog.jpg

2018-04-03T04:02:22Z

Aspandit:

File:EditButton.jpg

2018-04-03T04:02:05Z

Aspandit:

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:55:32Z

Aspandit: /* Edit topic */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#:[[File:ToBeDeleted.jpg]]
#Note that the topic is no longer in the table.
#:[[File:DeletedTopic.jpg]]

===== '''Edit topic''' =====
To edit a topic to an assignment,
#Select the [[File:editButton.jpg]] on the desired topic of the unfinished assignment that was navigated to in the first section.
#In the subsequent Edit Dialog, make the desired edits and click Save.
#:[[File:EditDialog.jpg]]
#The newly editted topic will appear with the new value(s).
#:[[File:NewlyEdittedTopic.jpg]]

===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:52:43Z

Aspandit: /* Delete topic */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#:[[File:ToBeDeleted.jpg]]
#Note that the topic is no longer in the table.
#:[[File:DeletedTopic.jpg]]

===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

File:DeletedTopic.jpg

2018-04-03T03:51:04Z

Aspandit:

File:ToBeDeleted.jpg

2018-04-03T03:49:46Z

Aspandit:

File:DeleteConfirmation.jpg

2018-04-03T03:49:30Z

Aspandit:

File:DeleteButton.jpg

2018-04-03T03:49:09Z

Aspandit:

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:48:59Z

Aspandit: /* Delete topic */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#:[[File:ToBeDeleted.jpg]]
#Note that the topic is no longer in the table.
#:[[DeletedTopic.jpg]]

===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:45:22Z

Aspandit: /* Delete topic */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
To Delete a topic from the Topics tab,
#Select the [[File:DeleteButton.jpg]] for the topic you wish to delete.
#Confirm that you would like to delete the selected topic.
#:[[File:DeleteConfirmation.jpg]]
#Note that the topic is no longer in the table.
#:[[DeletedTopic.jpg]]

===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

File:NewlyAddedTopic.jpg

2018-04-03T03:42:21Z

Aspandit:

File:AddDialog.jpg

2018-04-03T03:41:59Z

Aspandit:

File:AddButton.jpg

2018-04-03T03:41:38Z

Aspandit:

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:41:25Z

Aspandit: /* Add topic */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
To add a topic to an assignment,
#Select the [[File:addButton.jpg]] on the Topics tab of the unfinished assignment that was navigated to in the first section.
#In the subsequent Add Dialog, enter values for the Topic id, Topic name and Number of slots and click Save.
#:[[File:AddDialog.jpg]]
#The newly added topic will appear in the table sorted by Topic #.
#:[[File:NewlyAddedTopic.jpg]]

===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:32:23Z

Aspandit: /* Navigate to unfinished assignment */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.JPG]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.JPG]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.JPG]]

===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:28:21Z

Aspandit: /* Navigate to unfinished assignment */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
#Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
#Select "Manage..." -> "Assignments" from the dropdown at the top.
#:[[File:ManageAssignments.jpg]]
#Click the [[File:EditPencilIcon.jpg]] for the "Final Project (and Design Document)" assignment.
#Select the "Topics" tab for the assignment.
#:[[File:UnfinishedAssignmentsTabs.jpg]]
#Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
#:[[File:UnfinishedAssignmentTopicsTab.jpg]]

===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management

2018-04-03T03:16:34Z

Aspandit: /* Navigate to unfinished assignment */

This page provides a description of our Expertiza project.

__TOC__

'''>>>>>>>>>>>>> RUN "./setup.sh" BEFORE RUNNING APP; CONTENTS OF "bower.json" HAVE CHANGED <<<<<<<<<<<<<<'''

== Important links ==
* '''Deployed app: https://vast-bastion-53966.herokuapp.com/'''
* Github repo: https://github.com/dburcal/expertiza
* Github pull request: https://github.com/expertiza/expertiza/pull/1144

== Introduction ==

=== '''Expertiza Background''' ===

Expertiza is a web-based framework designed in Ruby on Rails to serve as a medium for students and professors to interact, provide feedback, and manage their assignments. It facilitates all of the electronic turn-ins and provides a good place to review your peers' work.

=== '''Problem Statement''' ===
To enhance topic management for instructors and students.
* '''Issue 971''': Change create topic UI to AJAX
::
* '''Issue 926''': Sort topics by topic number in assignment#edit
::
* '''Issue 718''': Allow instructors to give feedback when accepting or rejecting suggestions,add comments on those suggestions.
::

=== '''Our Goals''' ===
We planned to improve the functionality such that when instructors have to manage the topics for an assignment, they can do so much quicker and more reliably.

=== '''Files Edited''' ===

* app/spec/controllers/sign_up_sheet_controller_spec.rb
* app/spec/features/topic_suggestion_spec.rb
* app/assets/javascripts/application.js
* app/assets/javascripts/signup.js
* app/assets/stylesheets/application.scss
* app/assets/stylesheets/signup.scss.erb
* app/controllers/sign_up_sheet_controller.rb
* app/controllers/suggestion_controller.rb
* app/models/sign_up_topic.rb
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_add_topics.html.erb
* app/views/sign_up_sheet/_topic.html.erb
* app/views/signup/signup_topics.html.erb
* app/views/suggestion/show.html.erb
* app/views/suggestion/update_comment.html.erb
* app/views/suggestion/edit_comment.html.erb
* app/views/suggestion/_form_comment.html.erb
* config/routes.rb
* bower.json

== Issue 971 ==
==== '''Implementation''' ====
::The implementation of this functionality was started using < http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1781_Topic_Management > as a baseline. This issue calls for the replacement of the html table with a javascript table using jsGrid. The use of jsGrid in conjunction with AJAX calls allow for the user to complete actions such as edit and add for topics from a single page.

::Furthermore, replacing the html table with a dynamic table should not disrupt the html table for topic signup available to the student.

==== '''Further Implementation Required''' ====
::Addition of advertisements is pending. Values for formatting the width of the table columns to enable the table to fit the jQuery UI tab is present, but not fully operational.

==== '''Functionality walkthroughs''' ====
::The functionality below is for an instructor user unless mentioned otherwise.

===== '''Navigate to unfinished assignment''' =====
# Log in to < https://vast-bastion-53966.herokuapp.com > using the username "instructor6" and password "password".
# Select "Manage..." -> "Assignments" from the dropdown at the top.
[[File:ManageAssignments.jpg]]
# Click the [[File:PencilEditIcon.jpg]] for the "Final Project (and Design Document)" assignment.
# Select the "Topics" tab for the assignment.
[[File:UnfinishedAssignmentsTabs.jpg]]
# Note the available actions(add,edit,delete) and bookmarks available for each unfinished topic.
[[File:UnfinishedAssignmentTopicsTab.jpg]]

===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''Automatic Testing''' =====

::For testing the new functionality of methods in the sign_up_sheet_controller, we tested that JSON was correctly rendered from the load_add_signup_topics method, which loads the topics into the edit assignment table
::* There were four JSON outputs which were tested:
::**slots_waitlisted is correctly outputted as JSON
::**slots_filled_value is correctly outputted as JSON
::**slots_available is correctly outputted as JSON
::**participants is correctly outputted as JSON
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>

describe'#load_add_signup_topics' do
before(:each) do
allow(SignUpTopic).to receive(:where).with("assignment_id = ?", "1").and_return([topic])
allow(SignUpTopic).to receive(:find_slots_filled).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignUpTopic).to receive(:find_slots_waitlisted).with("1").and_return([double('SignedUpTeam', count: 0,topic_id: 1)])
allow(SignedUpTeam).to receive(:find_team_participants).with("1").and_return([double('User', topic_id: 0)])
params = {id: 1, topic_id: 1}
get :load_add_signup_topics, params
@parsed_response = JSON.parse( response.body )
end

it 'returns slots_waitlisted correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_waitlisted"]).to eq(0)
end

it 'returns slots_filled_value correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_filled_value"]).to eq(0)
end

it 'returns slots_available correctly as JSON' do
expect(@parsed_response["sign_up_topics"][0]["slots_available"]).to eq(1)
end

context 'There are no participants' do
it 'returns participants as empty as JSON' do
expect(@parsed_response["sign_up_topics"][0]["participants"]).to be_empty
end
end
end

</pre>

==== '''Testing Walkthrough''' ====
::In order to test this area of the project, you need to:
::*Install the environment using ./setup.sh
::*run bundle install
::*run 'rspec spec/controllers/sign_up_sheet_controller_spec.rb'

==== '''Further Testing Required''' ====
::Overall there are a few more outputs from the method that could be tested. These are values that are pivotal to the table and so testing them is important, so if we are able to, we would like to add those to the project as well, but besides that are proud of the tests that do work.

== Issue 926 ==
==== '''Implementation''' ====
::We let JSGrid handle the sorting of topics by the headers in the table. We altered the AJAX controller to enable this sorting.

==== '''Further Implementation Required''' ====
::While the table is able to be sorted by the header row, whenever you make a new topic the initial list of topics is not resorted right away. This leads to say E1502, a new topic just made, to be at the bottom of the list when it would normally precede say E1700, if it were in the same topic list.

==== '''Testing''' ====
::There is no testing required in this aspect, since sorting is a feature of the AJAX table itself, and therefore it wouldn't make sense to test the implementation.

== Issue 718 ==
==== '''Implementation''' ====
::We implemented the functionality for approving and rejecting any topic suggestions made by the students. Furthermore we have included comments which the instructor can give for a particular topic suggestion. Some tests have been added to verify the above functionality. The functionality of editing comments also has been correctly implemented.
::'''Goals achieved according to the spec file:'''
::1. Implement approving and rejecting suggestions.
::2. Adding comments to the suggestions(can be multiple).
::'''Additional Goals achieved:'''
::1. Editing comments in the suggestions view.
::2. Removing redundant Approve and Reject suggestion button which were present on the suggestion screen.
::'''Files which have been changed to reflect the changes:'''
::1. '''app/view/suggestion/show.html.erb'''
::*To see all the comments and to edit individual comments:
<pre>
<table class="general" cellpadding=5 border="1">
<colgroup>
<col width=15% />
<col width=15% />
<col width=25% />
</colgroup>
<tr>
<th>Commenter</th>
<th>Vote</th>
<th>Comment</th>
</tr>

<% for suggestioncomment in @suggestion.suggestion_comments %>
<tr>

<td class="listingRow" align="center"><%=suggestioncomment.commenter %></td>
<td class="listingRow" align="center">
<%if suggestioncomment.vote == 'Y' %>
Yes
<%elsif suggestioncomment.vote == 'N'%>
No
<%elsif suggestioncomment.vote == 'R'%>
Revise

<%elsif suggestioncomment.vote == 'A'%>
Approved
<%elsif suggestioncomment.vote == 'D'%>
Denied
<%else%>
--
<%end%>
</td>
<td class="listingRow" align="center"><%= suggestioncomment.comments%></td>

<td><%= link_to "Edit Comment",{:controller=>"suggestion",:action=>"edit_comment",:suggestioncomment=>suggestioncomment}%></td>
</tr>

<%end%>
</table>
</pre>
::*To add a comment:
<pre>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' %>
<b>Add new comment and vote</b> <br>
<%= form_tag :action => 'submit', :id => @suggestion do %>
<%= text_area "suggestion_comment", "comments", :rows => 5, :cols => 50 %>
<p>
<%= "Vote"%>
<%= select("suggestion_comment","vote",{"Yes" =>"Y","No"=>"N","Revise"=>"R"}) %>
</p>

<%= submit_tag "Submit vote", :name => 'add_comment' %>
<% if @suggestion.status != 'Approved' && @suggestion.status != 'Rejected' && session[:user] != nil && (session[:user].role_id == 2 || session[:user].role_id == 3 || session[:user].role_id == 4) %>
<%= submit_tag "Approve suggestion", :name => 'approve_suggestion' %>
<%= submit_tag "Reject suggestion", :name => 'reject_suggestion' %>
<% end %>
<% end %>

<% end %>
</pre>
::2. '''app/views/suggestion/edit_comment.html.erb'''
::*Link to form for editing
<pre>
< Editing suggestion comments>
<tr><%= render :partial =>"form_comment", suggestion_comment: @suggestioncomment %></tr>
<tr><%#= link_to 'Back', :action => 'show', :id => suggestion %></tr>
</pre>
::3. '''app/views/suggestion/_form_comment.html.erb'''
::*Form for editing:
<pre>
<%= form_for :suggestioncomment,:url=>{:controller=>"suggestion",:action=>"update_comment",:id=>@suggestioncomment.id},:method=>"post" do |form|%>
<div class="field">
<%= form.label :comments %>
<%= form.text_area :comments,value: @suggestioncomment.comments,:rows => 5, :cols => 50%>
</div>

<div class = "field">
<%= form.label :vote%>
<%= form.text_field :vote,value: @suggestioncomment.vote %>
</div>
<%= form.hidden_field :suggestioncomment,value: @suggestioncomment%>
<%= form.hidden_field :id,value: @suggestioncomment.suggestion_id%>
<div class="actions">
Click to Update
<%= form.submit%>
</div>
<% end %>
<tr><%= link_to 'Back',:controller=>"suggestion", :action => "show",:id => @suggestioncomment.suggestion_id %></tr>
</pre>
::4. '''app/controllers/suggestion_controller.rb'''

::*For approving and rejecting suggestions:
<pre>
def approve_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of approval as well.
# Thus we are getting the comments through the request when approval is made and saving those in
# Database with Vote type as A - meaning approval
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'A', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Accepted')
flash[:notice] = 'The suggestion has been successfully accepted.'
else
flash[:error] = 'An error occurred when accepting the suggestion.'
end

redirect_to action: 'show', id: @suggestion
end

def reject_suggestion
# 1781 - 718 issue
# The Instructor should be able to give feed backs during the times of rejection as well.
# Thus we are getting the comments through the request when denial is made and saving those in
# Database with Vote type as D - meaning reject
if params[:suggestion_comment][:comments] && params[:suggestion_comment][:comments] != ""
@suggestioncomment = SuggestionComment.new(vote: 'D', comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
@suggestioncomment.save
end
@suggestion = Suggestion.find(params[:id])

if @suggestion.update_attribute('status', 'Rejected')
flash[:notice] = 'The suggestion has been successfully rejected.'
else
flash[:error] = 'An error occurred when rejecting the suggestion.'
end
redirect_to action: 'show', id: @suggestion
end
</pre>
::*For adding a comment:
<pre>
def add_comment
@suggestioncomment = SuggestionComment.new(vote: params[:suggestion_comment][:vote], comments: params[:suggestion_comment][:comments])
@suggestioncomment.suggestion_id = params[:id]
@suggestioncomment.commenter = session[:user].name
if @suggestioncomment.save
flash[:notice] = "Your comment has been successfully added."
else
flash[:error] = "There was an error in adding your comment."
end
if current_role_name.eql? 'Student'
redirect_to action: "student_view", id: params[:id]
else
redirect_to action: "show", id: params[:id]
end
end
</pre>
::*For editing comments:
<pre>
def edit_comment
@suggestioncomment = SuggestionComment.find(params[:suggestioncomment])
end
</pre>
::*For updating comments:
<pre>
def update_comment
@suggestioncomment = SuggestionComment.find(params[:id])
@suggestioncomment.update(suggestioncomment_params)
#if @suggestioncomment.update(suggestioncomment_params)
#redirect_to :action=>"show",:id=>@suggestioncomment.suggestion_id
#end
end
</pre>

::Images showing the jist for testing

==== '''Further Implementation Required''' ====

==== '''Testing''' ====

===== '''UI Testing''' =====
::''''The following steps should be followed to test the functionality:''''
::''''1. Login as a student2065/2064/2066 with password:password''''
::''''2. Select any assignment,for example Click on view(RHS of the assignment)"wiki Textbook" and then click on "suggest a topic".''''
[[File:Rsz_capturestu_1.png|frame|center|x|]]

[[File:Rsz_capturestu_2.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Rsz_1capturestu_3.png|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Rsz_capturea.png|frame|center|x|]]
::''''6. Click on the "view suggestion" icon on the right side of the screen.''''
::''''7. Add a comment on that suggestion and submit.''''
[[File:Rsz_capturesugg_comm.png|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureedit.png|frame|center|x|]]
::''''9. Login as student and you can see the comment when you go to the assignment and associated topic.''''
::
::
::Tests have been added to the spec for testing the above functionality.The following changes are made to the related spec files.
::'''spec/features/topic_suggestion_spec.rb'''

===== '''Automatic Testing''' ======
<pre>
#part 2###########################
#######part 2#####################
#############part 2###############issue 718
###################part 2#########
#########################part 2###
describe "topic_suggestion" do
it "Instructor set an assignment which allow student suggest topic and register student2066" do
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Assignment_suggest_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end

it " student2066 hold suggest topic and suggest a new one and student2064 enroll on waitlist of suggested topic", js: true do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# case 2 student already have topic switch to new topic
# need two students one to be on the waitlist of previous suggested topic,
# the other one (student2064) is holding it and suggest another topic and wish to switch to the new one
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
first("img[title='Signup']").click

# log in student2064
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_will_switch'
fill_in 'suggestion_description', with: 'suggested_description_2'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as instructor6 to approve the 2nd suggested topic
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_will_switch"
# find link for new suggested view
visit '/suggestion/2'
# click_link('View')
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login as student 2064 to switch to new approved topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link('Assignment_suggest_topic',match: :first)
click_link('Signup sheet',match: :first)
expect(page).to have_content "Your approved suggested topic"
expect(page).to have_content "suggested_topic"
expect(page).to have_content "suggested_topic2_will_switch"
first("img[title='Switch Topic']").click

# login as student 2066 to see if it's holding the topic rather than on the wait list
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login as studnet 2064 to see if it's already shifted to the new suggested topic
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "suggested_topic2_will_switch"
end

########################################
# Case 3:
# One team is holding a topic. They sent a suggestion for new topic, and keep themselves in old topic
########################################
it "student2066 hold suggest topic and suggest a new one, but wish to stay in the old topic", js: true do
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
# DUE date need to be added here
visit '/suggestion/list?id=1&type=Assignment'
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

######################################
# One team is holding a topic. They sent a suggestion for new topic
######################################
# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2066 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic2_without_switch'
fill_in 'suggestion_description', with: 'suggested_description2_without_switch'
find('#suggestion_signup_preference').find(:xpath, 'option[2]').select_option
click_button 'Submit',match: :first
expect(page).to have_content "Thank you for your suggestion"

# login_as "instructor6"
user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/tree_display/list'
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic2_without_switch"
find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", text: 'View').click
# click_link('View')

expect(page).to have_content "suggested_description2_without_switch"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."

# login_as "student2066"
user = User.find_by(name: 'student2066')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content "suggested_topic2_without_switch"
# click_link('publish_approved_suggested_topic')
visit '/sign_up_sheet/publish_approved_suggested_topic/2?assignment_id=1'
# find(:xpath, "//tr[contains(.,'suggested_topic2_without_switch')]/td/a", :figure=>"Publish Topic").click
visit '/student_task/list'
expect(page).to have_content "suggested_topic"

# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Signup sheet"
click_link('Signup sheet',match: :first)
expect(page).to have_content " suggested_topic2_without_switch"
find(:xpath, "(//img[@title='Signup'])[2]").click
visit '/student_task/list'
expect(page).to have_content " suggested_topic2_without_switch"
end

it "professor could approve anonymous suggestion topic" do
# login_as "student2064"
user = User.find_by(name: 'student2064')
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
expect(page).to have_content "Assignment_suggest_topic"

# student2064 suggest topic
click_link('Assignment_suggest_topic',match: :first)
expect(page).to have_content "Suggest a topic"
click_link('Suggest a topic',match: :first)
fill_in 'suggestion_title', with: 'suggested_topic'
fill_in 'suggestion_description', with: 'suggested_description'
find(:xpath, "//input[@name='suggestion_anonymous']").click
click_button 'Submit',match: :first
expect(page).to have_content "You have submitted an anonymous suggestion."

user = User.find_by(name: 'instructor6')
stub_current_user(user, user.role.name, user.role)

# instructor approve the suggestion topic
visit '/suggestion/list?id=1&type=Assignment'
expect(page).to have_content "Suggested topics for Assignment_suggest_topic"
expect(page).to have_content "suggested_topic"
click_link('View',match: :first)
expect(page).to have_content "suggested_description"
click_button 'Approve suggestion',match: :first
expect(page).to have_content "The suggestion was successfully approved."
end
end
</pre>

==== '''Further Testing Required''' ====
::More tests need to be added to test whether an instructor can edit a comment or not.

File:UnfinishedAssignmentTopicsTab.JPG

2018-04-03T03:09:54Z

Aspandit:

File:UnfinishedAssignmentsTabs.JPG

2018-04-03T03:09:44Z

Aspandit:

File:EditPencilIcon.JPG

2018-04-03T03:09:10Z

Aspandit: