Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T03:27:11Z

Pkeny: /* Links */

== Introduction ==

=== Overview of Project ===

Expertiza contains Peer-Review where in all students are asked to review the work done by their fellow classmates. The rubric for the same are created by instructors. These Rubrics contain questions that are related to the submitted topics. But sometimes students have questions which may or may not be related to the work other students are working on. So there is no option currently available to ask these questions to their peers. This project (E1817) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

=== Proposed Solution ===

In order to solve the above problem, we intend to add Supplementary Review Questions to the existing Review Questions already added by the instructor. These “extra” questions will not be graded. However, they will increase the benefit that each person gets because they can get feedback that is specific to their project. The rest of this document describes the design and approach for project E1817.

== Implementation ==

In Expertiza, all rubrics and surveys are subclasses of Questionnaire. A Questionnaire has “questions” that make use of checkboxes, dropdowns, text boxes, etc. We want to add a new subclass of Questionnaire called SupplementaryReviewQuestionnaire to help us implement this project.

=== Design Strategy ===
The flowcharts below describes the design that we chose to implement for this project.

*When a student wants to create/edit Supplementary Review Questionnaire
** If the instructor has enabled a particular assignment to have supplementary review questionnaire only then a student can create a supplementary review questionnaire. A student can click on the "Your Work" tab and see a link to the add/edit Supplementary Review Questionnaire. This link directs the student to the create review questionnaire(same as instructor).
**When a student creates a Supplementary Review Questionnaire (SRQ), the entry in the SRQ column added to the Teams table will contain the questionnaire id to link the SRQ with the team that generated it. If the SRQ column of a team is empty it means no supplementary review questionnaire was created. If its not empty, it will indicate that a supplementary review questionnaire was created.

[[File:1flow.PNG]]

[[File:2flow.PNG]]

*When Reviewer wants to access the Review Questions.
** When a reviewer requests for a review, first the entry of the SRQ column in the Teams table is checked to see if supplementary review questionnaire was added. If the field is not empty, the supplementary review questionnaire is appended to the existing review questionnaire created by the instructor. Otherwise the reviewer only sees the default review questionnaire.

[[File:3flow.PNG]]

*When responses of questionnaire need to be displayed
** When the responses of the reviewer is recorded, the student can click on "View Scores" tab for a particular assignment which contains the responses of the reviewer. This view should contain the responses for both the default review questions as well the supplementary review questions added by the student. So if the entry of the SRQ column in the Teams table is not empty the responses of the supplementary review questions is appended to the responses of the default review questions.
'''NOTE''': The responses of the Supplementary Review Questions will not be added to the review scores of the project. It will just be shown to the team that has asked these questions so that they can see what suggestions does the reviewer has for the questions.

[[File:4flow.PNG]]

=== Changes in the User Interface ===

The following changes need to be made to the User Interface.

*Assignment Page
**An assignment will have a checkbox that the instructor can ‘check’ to enable a student to add supplementary review rubric. Once ‘checked’ a button or link will appear in the student's "Your Work" section. This link will redirect the student to the same page that an instructor lands on when creating a new rubric, which will allow the student to create a review rubric just like an instructor does.
:[[File:Finaledit1r.png]]

*A link called "Supplemantary Review Questionnaire" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the link he/she can add the desired questions.
:[[File:rsz_link.png]]

* The page where student will be directed to when he/she clicks the Supplementary Review Questionnaire link.
:[[File:rsz_review.png]]

* The page which allows students to add different types of questions to the Supplementary Review Questionnaire.
:[[File:rsz_append.png]]

*Review Page
**When a reviewer fills out a rubric, the ResponseController will display a set of rubrics, in order, on the same page. This set would normally consist of just a review rubric, which is a Response object. However, the set would now have a review rubric and a supplementary review rubric (two items in the set instead of one) if the Supplementary Review rubric has been added. Thus, now the reviewer will be able to see the Supplementary Review questions along with the existing review questions.

*Review Results Page
**The “View” function for a rubric will display answers submitted for the SupplementaryReviewQuestionnaire as well as the ReviewQuestionnaire. We will add another column to the “View scores” page (for both instructor and students) so that the responses of the Supplementary Review Questions are also shown to student.
'''NOTE''':The student-generated questions (Supplementary Review Questions) will not be graded to avoid encouraging students to ask “easy” questions so that their reviewers would give them a high scores.

== Test Plan ==

Firstly, we need to add tests for the following:

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

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

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

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

'''Supplementary Review Questionnaire Testing : '''supplementary_review_rubric_spec.rb :
:In this test, we are testing the addition and editing of the supplementary questionnaire. Furthermore, we are also checking whether the questionnaire is being displayed or not to the reviewer. Also a test has been added to check if the questionnaire gets added to the model.
<pre>
include TopicHelper
describe "supplementary rubric testing" do
before(:each) do
# create assignment and topic
create(:assignment, name: "TestAssignment", directory_path: "TestAssignment")
create_list(:participant, 3)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).first, team: AssignmentTeam.first)
create(:topic, topic_name: "TestTopic")
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_questionnaire)
create(:questionnaire)
create(:question)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
end

it "has srq to add/edit supplementary questionnaire" do
signup_topic
expect(page).to have_content "Create Supplementary Review Questionnaire"
end

it "add supplementary questionnaire to teams model" do
signup_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
# assert !Team.supplementary_rubric_by_team_id(2).nil?
end

it "should display Supplementary Questionnaire to assigned student" do
submit_to_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
user = User.find_by(name: "student2066")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link "TestAssignment"
click_link "Others' work"
find(:css, "#i_dont_care").set(true)
click_button "Request a new submission to review"
click_link "Begin"
#expect(page).to have_content "Supplementary Reviewee Generated Questions"
end
end
</pre>

''' Topic Helper : '''topic_helper.rb :
:This file is included in the helper folder inside spec/features. This helper is used because the given methods are used in more than one place and to keep the code "DRY". In the first method we are stubbing the user so that that user signs up for an assignment. In the second method more testing is being performed to test the upload link.
<pre>
module TopicHelper
def signup_topic
user = User.find_by(name: "student2064")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
visit '/sign_up_sheet/sign_up?id=1&topic_id=1' # signup topic
visit '/student_task/list'
click_link "TestAssignment"
click_link "Your work"
end

def submit_to_topic
signup_topic
fill_in 'submission', with: "https://www.ncsu.edu"
click_on 'Upload link'
expect(page).to have_content "https://www.ncsu.edu"

end
end
</pre>

== File which are added/modified ==

As of now, we have figured out that the following files need to be added/modified:

1. '''app/models/supplementary_review_questionnaire.rb'''
*Added a migration to create a subclass "SupplementaryReviewQuestionnaire".

2. '''db/migrate/add_srq_id_to_teams.rb'''
*Added a migration which will add the Supplementary Review Questionnaire id column to the "Teams" table. This is to link the team which created the supplementary review questionnaire to the created questionnaire.

3. '''config/routes.rb'''
*To create Supplementary Review Questionnaire

4. '''app/controllers/response_controller.rb'''
* Obtained supplementary review questionnaire from the questionnaires table for new response
<pre>
def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@contributor.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

</pre>
* Obtained answers for the supplementary review questionnaire from the responses
<pre>
def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)
# added for srq
sr_answer = @response.scores.last
@sr_questionnaire = @response.questionnaire_by_answer(sr_answer)
end
</pre>
* Appended responses of the supplementary review questionnaire in the edit method
<pre>
def edit
@header = "Edit"
@next_action = "update"
@return = params[:return]
@response = Response.find(params[:id])
@map = @response.map
@contributor = @map.contributor
set_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i and m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content(new_response = true)
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
# added for srq
@sr_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
render action: 'response'
end
</pre>

* Append questions of supplementary review questionnaire in create method and set content method
<pre>
def create
map_id = params[:id]
map_id = params[:map_id] if !params[:map_id].nil?# pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
# added for srq
@team_id = @map.reviewee_id
set_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team_id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')

if params[:saved].nil? || params[:saved] == "0" # a flag so the autosave doesn't create different versions. The value's changed by the javascript in response.js
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round,
is_submitted: is_submitted
)
else
@response = Response.find_by(map_id: @map.id, round: @round)
if !@response.nil?
@response.update(additional_comment: params[:review][:comments]) # ignore if autoupdate try to save when the response object is not yet created.
else
logger.error("Can't find response with '#{@map.id}' and round '#{@round}' to update, even though params[:saved] = #{params[:saved]}")
end
end

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
sr_questions = sort_questions(@sr_questionnaire.questions)
questions += sr_questions
end
create_answers(params, questions) if params[:responses]

msg = "Your response was successfully saved."
error_msg = ""
# @response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
# @response.email
redirect_to controller: 'response', action: 'saving', id: @map.map_id, return: params[:return], msg: msg, error_msg: error_msg, save_options: params[:save_options]
end
</pre>
<pre>
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
@sr_questions = sort_questions(@sr_questionnaire.questions)
end
@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end
</pre>
5. '''app/controllers/grades_controller.rb'''
:Added supplementary review responses to "Your Scores" section.
<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
questionnaires.each do |questionnaire|
@round = if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
AssignmentQuestionnaire.find_by(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).used_in_round
end
vm = VmQuestionResponse.new(questionnaire, @assignment)
vmquestions = questionnaire.questions
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
unless @sr_questionnaire.nil?
sr_questions = @sr_questionnaire.questions
end
end
vmquestions += sr_questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>
6. '''app/views/assignments/edit/_rubrics.html.erb'''
*Add a checkbox called "Allow students to create supplementary review questionnaire" .
<pre>
<input name="assignment_form[assignment][srq]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][srq]', 'true', @assignment_form.assignment.srq) %>
<%= label_tag('assignment_form[assignment][srq]', 'Allow students to add Supplementary Review Questionnaire?') %>
</pre>

7. '''app/views/submitted_content/_main.html.erb'''
*Created a link " Create Supplementary Review Questionnaire" to appear in the student's "Your Work" section if the instructor has enabled student generated Questions for this assignment.
<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.srq? %>
<%= link_to "Create Supplementary Review Questionnaire", {:controller => "questionnaires", :action => "create_srq", :id => participant.id } %>
<% else %>
The instructor has not enabled this feature for this assignment
<% end %>
<% end %>
</pre>

8. '''app/controllers/questionnaires_controller'''
* Added a method to create Supplementary Review Questionnaire
<pre>
def create_srq
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.srq_id.nil? then
@questionnaire = Questionnaire.new
@questionnaire.private = false
@questionnaire.name = "SRQ_" + @team.id.to_s
@questionnaire.instructor_id = @team.id
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 5
@questionnaire.type = "SupplementaryReviewQuestionnaire"
@questionnaire.display_type = "SupplementaryReviewQuestionnaire"
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
@team.srq_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a questionnaire!'
else
@questionnaire = Questionnaire.find(@team.srq_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

</pre>

== Team members ==
*Shrinath Cheriyana
*Sanika Sabnis
*Pratik Keny
*Praneet Mocherla

== Links ==
*Expertiza on Github:https://github.com/Pratik2611/expertiza/tree/shrinathedit
*Pull Request: https://github.com/expertiza/expertiza/pull/1178
*Expertiza YouTube channel:

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T03:26:55Z

Pkeny: /* Links */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T03:26:32Z

Pkeny: /* Team members */

== Introduction ==

=== Overview of Project ===

Expertiza contains Peer-Review where in all students are asked to review the work done by their fellow classmates. The rubric for the same are created by instructors. These Rubrics contain questions that are related to the submitted topics. But sometimes students have questions which may or may not be related to the work other students are working on. So there is no option currently available to ask these questions to their peers. This project (E1817) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

=== Proposed Solution ===

In order to solve the above problem, we intend to add Supplementary Review Questions to the existing Review Questions already added by the instructor. These “extra” questions will not be graded. However, they will increase the benefit that each person gets because they can get feedback that is specific to their project. The rest of this document describes the design and approach for project E1817.

== Implementation ==

In Expertiza, all rubrics and surveys are subclasses of Questionnaire. A Questionnaire has “questions” that make use of checkboxes, dropdowns, text boxes, etc. We want to add a new subclass of Questionnaire called SupplementaryReviewQuestionnaire to help us implement this project.

=== Design Strategy ===
The flowcharts below describes the design that we chose to implement for this project.

*When a student wants to create/edit Supplementary Review Questionnaire
** If the instructor has enabled a particular assignment to have supplementary review questionnaire only then a student can create a supplementary review questionnaire. A student can click on the "Your Work" tab and see a link to the add/edit Supplementary Review Questionnaire. This link directs the student to the create review questionnaire(same as instructor).
**When a student creates a Supplementary Review Questionnaire (SRQ), the entry in the SRQ column added to the Teams table will contain the questionnaire id to link the SRQ with the team that generated it. If the SRQ column of a team is empty it means no supplementary review questionnaire was created. If its not empty, it will indicate that a supplementary review questionnaire was created.

[[File:1flow.PNG]]

[[File:2flow.PNG]]

*When Reviewer wants to access the Review Questions.
** When a reviewer requests for a review, first the entry of the SRQ column in the Teams table is checked to see if supplementary review questionnaire was added. If the field is not empty, the supplementary review questionnaire is appended to the existing review questionnaire created by the instructor. Otherwise the reviewer only sees the default review questionnaire.

[[File:3flow.PNG]]

*When responses of questionnaire need to be displayed
** When the responses of the reviewer is recorded, the student can click on "View Scores" tab for a particular assignment which contains the responses of the reviewer. This view should contain the responses for both the default review questions as well the supplementary review questions added by the student. So if the entry of the SRQ column in the Teams table is not empty the responses of the supplementary review questions is appended to the responses of the default review questions.
'''NOTE''': The responses of the Supplementary Review Questions will not be added to the review scores of the project. It will just be shown to the team that has asked these questions so that they can see what suggestions does the reviewer has for the questions.

[[File:4flow.PNG]]

=== Changes in the User Interface ===

The following changes need to be made to the User Interface.

*Assignment Page
**An assignment will have a checkbox that the instructor can ‘check’ to enable a student to add supplementary review rubric. Once ‘checked’ a button or link will appear in the student's "Your Work" section. This link will redirect the student to the same page that an instructor lands on when creating a new rubric, which will allow the student to create a review rubric just like an instructor does.
:[[File:Finaledit1r.png]]

*A link called "Supplemantary Review Questionnaire" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the link he/she can add the desired questions.
:[[File:rsz_link.png]]

* The page where student will be directed to when he/she clicks the Supplementary Review Questionnaire link.
:[[File:rsz_review.png]]

* The page which allows students to add different types of questions to the Supplementary Review Questionnaire.
:[[File:rsz_append.png]]

*Review Page
**When a reviewer fills out a rubric, the ResponseController will display a set of rubrics, in order, on the same page. This set would normally consist of just a review rubric, which is a Response object. However, the set would now have a review rubric and a supplementary review rubric (two items in the set instead of one) if the Supplementary Review rubric has been added. Thus, now the reviewer will be able to see the Supplementary Review questions along with the existing review questions.

*Review Results Page
**The “View” function for a rubric will display answers submitted for the SupplementaryReviewQuestionnaire as well as the ReviewQuestionnaire. We will add another column to the “View scores” page (for both instructor and students) so that the responses of the Supplementary Review Questions are also shown to student.
'''NOTE''':The student-generated questions (Supplementary Review Questions) will not be graded to avoid encouraging students to ask “easy” questions so that their reviewers would give them a high scores.

== Test Plan ==

Firstly, we need to add tests for the following:

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

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

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

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

'''Supplementary Review Questionnaire Testing : '''supplementary_review_rubric_spec.rb :
:In this test, we are testing the addition and editing of the supplementary questionnaire. Furthermore, we are also checking whether the questionnaire is being displayed or not to the reviewer. Also a test has been added to check if the questionnaire gets added to the model.
<pre>
include TopicHelper
describe "supplementary rubric testing" do
before(:each) do
# create assignment and topic
create(:assignment, name: "TestAssignment", directory_path: "TestAssignment")
create_list(:participant, 3)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).first, team: AssignmentTeam.first)
create(:topic, topic_name: "TestTopic")
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_questionnaire)
create(:questionnaire)
create(:question)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
end

it "has srq to add/edit supplementary questionnaire" do
signup_topic
expect(page).to have_content "Create Supplementary Review Questionnaire"
end

it "add supplementary questionnaire to teams model" do
signup_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
# assert !Team.supplementary_rubric_by_team_id(2).nil?
end

it "should display Supplementary Questionnaire to assigned student" do
submit_to_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
user = User.find_by(name: "student2066")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link "TestAssignment"
click_link "Others' work"
find(:css, "#i_dont_care").set(true)
click_button "Request a new submission to review"
click_link "Begin"
#expect(page).to have_content "Supplementary Reviewee Generated Questions"
end
end
</pre>

''' Topic Helper : '''topic_helper.rb :
:This file is included in the helper folder inside spec/features. This helper is used because the given methods are used in more than one place and to keep the code "DRY". In the first method we are stubbing the user so that that user signs up for an assignment. In the second method more testing is being performed to test the upload link.
<pre>
module TopicHelper
def signup_topic
user = User.find_by(name: "student2064")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
visit '/sign_up_sheet/sign_up?id=1&topic_id=1' # signup topic
visit '/student_task/list'
click_link "TestAssignment"
click_link "Your work"
end

def submit_to_topic
signup_topic
fill_in 'submission', with: "https://www.ncsu.edu"
click_on 'Upload link'
expect(page).to have_content "https://www.ncsu.edu"

end
end
</pre>

== File which are added/modified ==

As of now, we have figured out that the following files need to be added/modified:

1. '''app/models/supplementary_review_questionnaire.rb'''
*Added a migration to create a subclass "SupplementaryReviewQuestionnaire".

2. '''db/migrate/add_srq_id_to_teams.rb'''
*Added a migration which will add the Supplementary Review Questionnaire id column to the "Teams" table. This is to link the team which created the supplementary review questionnaire to the created questionnaire.

3. '''config/routes.rb'''
*To create Supplementary Review Questionnaire

4. '''app/controllers/response_controller.rb'''
* Obtained supplementary review questionnaire from the questionnaires table for new response
<pre>
def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@contributor.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

</pre>
* Obtained answers for the supplementary review questionnaire from the responses
<pre>
def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)
# added for srq
sr_answer = @response.scores.last
@sr_questionnaire = @response.questionnaire_by_answer(sr_answer)
end
</pre>
* Appended responses of the supplementary review questionnaire in the edit method
<pre>
def edit
@header = "Edit"
@next_action = "update"
@return = params[:return]
@response = Response.find(params[:id])
@map = @response.map
@contributor = @map.contributor
set_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i and m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content(new_response = true)
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
# added for srq
@sr_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
render action: 'response'
end
</pre>

* Append questions of supplementary review questionnaire in create method and set content method
<pre>
def create
map_id = params[:id]
map_id = params[:map_id] if !params[:map_id].nil?# pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
# added for srq
@team_id = @map.reviewee_id
set_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team_id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')

if params[:saved].nil? || params[:saved] == "0" # a flag so the autosave doesn't create different versions. The value's changed by the javascript in response.js
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round,
is_submitted: is_submitted
)
else
@response = Response.find_by(map_id: @map.id, round: @round)
if !@response.nil?
@response.update(additional_comment: params[:review][:comments]) # ignore if autoupdate try to save when the response object is not yet created.
else
logger.error("Can't find response with '#{@map.id}' and round '#{@round}' to update, even though params[:saved] = #{params[:saved]}")
end
end

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
sr_questions = sort_questions(@sr_questionnaire.questions)
questions += sr_questions
end
create_answers(params, questions) if params[:responses]

msg = "Your response was successfully saved."
error_msg = ""
# @response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
# @response.email
redirect_to controller: 'response', action: 'saving', id: @map.map_id, return: params[:return], msg: msg, error_msg: error_msg, save_options: params[:save_options]
end
</pre>
<pre>
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
@sr_questions = sort_questions(@sr_questionnaire.questions)
end
@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end
</pre>
5. '''app/controllers/grades_controller.rb'''
:Added supplementary review responses to "Your Scores" section.
<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
questionnaires.each do |questionnaire|
@round = if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
AssignmentQuestionnaire.find_by(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).used_in_round
end
vm = VmQuestionResponse.new(questionnaire, @assignment)
vmquestions = questionnaire.questions
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
unless @sr_questionnaire.nil?
sr_questions = @sr_questionnaire.questions
end
end
vmquestions += sr_questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>
6. '''app/views/assignments/edit/_rubrics.html.erb'''
*Add a checkbox called "Allow students to create supplementary review questionnaire" .
<pre>
<input name="assignment_form[assignment][srq]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][srq]', 'true', @assignment_form.assignment.srq) %>
<%= label_tag('assignment_form[assignment][srq]', 'Allow students to add Supplementary Review Questionnaire?') %>
</pre>

7. '''app/views/submitted_content/_main.html.erb'''
*Created a link " Create Supplementary Review Questionnaire" to appear in the student's "Your Work" section if the instructor has enabled student generated Questions for this assignment.
<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.srq? %>
<%= link_to "Create Supplementary Review Questionnaire", {:controller => "questionnaires", :action => "create_srq", :id => participant.id } %>
<% else %>
The instructor has not enabled this feature for this assignment
<% end %>
<% end %>
</pre>

8. '''app/controllers/questionnaires_controller'''
* Added a method to create Supplementary Review Questionnaire
<pre>
def create_srq
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.srq_id.nil? then
@questionnaire = Questionnaire.new
@questionnaire.private = false
@questionnaire.name = "SRQ_" + @team.id.to_s
@questionnaire.instructor_id = @team.id
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 5
@questionnaire.type = "SupplementaryReviewQuestionnaire"
@questionnaire.display_type = "SupplementaryReviewQuestionnaire"
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
@team.srq_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a questionnaire!'
else
@questionnaire = Questionnaire.find(@team.srq_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

</pre>

== Team members ==
*Shrinath Cheriyana
*Sanika Sabnis
*Pratik Keny
*Praneet Mocherla

== Links ==
*Expertiza on Github:https://github.com/Pratik2611/expertiza/tree/shrinathedit
*Expertiza YouTube channel: https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg/videos

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T03:26:18Z

Pkeny: /* Team members */

== Introduction ==

=== Overview of Project ===

Expertiza contains Peer-Review where in all students are asked to review the work done by their fellow classmates. The rubric for the same are created by instructors. These Rubrics contain questions that are related to the submitted topics. But sometimes students have questions which may or may not be related to the work other students are working on. So there is no option currently available to ask these questions to their peers. This project (E1817) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

=== Proposed Solution ===

In order to solve the above problem, we intend to add Supplementary Review Questions to the existing Review Questions already added by the instructor. These “extra” questions will not be graded. However, they will increase the benefit that each person gets because they can get feedback that is specific to their project. The rest of this document describes the design and approach for project E1817.

== Implementation ==

In Expertiza, all rubrics and surveys are subclasses of Questionnaire. A Questionnaire has “questions” that make use of checkboxes, dropdowns, text boxes, etc. We want to add a new subclass of Questionnaire called SupplementaryReviewQuestionnaire to help us implement this project.

=== Design Strategy ===
The flowcharts below describes the design that we chose to implement for this project.

*When a student wants to create/edit Supplementary Review Questionnaire
** If the instructor has enabled a particular assignment to have supplementary review questionnaire only then a student can create a supplementary review questionnaire. A student can click on the "Your Work" tab and see a link to the add/edit Supplementary Review Questionnaire. This link directs the student to the create review questionnaire(same as instructor).
**When a student creates a Supplementary Review Questionnaire (SRQ), the entry in the SRQ column added to the Teams table will contain the questionnaire id to link the SRQ with the team that generated it. If the SRQ column of a team is empty it means no supplementary review questionnaire was created. If its not empty, it will indicate that a supplementary review questionnaire was created.

[[File:1flow.PNG]]

[[File:2flow.PNG]]

*When Reviewer wants to access the Review Questions.
** When a reviewer requests for a review, first the entry of the SRQ column in the Teams table is checked to see if supplementary review questionnaire was added. If the field is not empty, the supplementary review questionnaire is appended to the existing review questionnaire created by the instructor. Otherwise the reviewer only sees the default review questionnaire.

[[File:3flow.PNG]]

*When responses of questionnaire need to be displayed
** When the responses of the reviewer is recorded, the student can click on "View Scores" tab for a particular assignment which contains the responses of the reviewer. This view should contain the responses for both the default review questions as well the supplementary review questions added by the student. So if the entry of the SRQ column in the Teams table is not empty the responses of the supplementary review questions is appended to the responses of the default review questions.
'''NOTE''': The responses of the Supplementary Review Questions will not be added to the review scores of the project. It will just be shown to the team that has asked these questions so that they can see what suggestions does the reviewer has for the questions.

[[File:4flow.PNG]]

=== Changes in the User Interface ===

The following changes need to be made to the User Interface.

*Assignment Page
**An assignment will have a checkbox that the instructor can ‘check’ to enable a student to add supplementary review rubric. Once ‘checked’ a button or link will appear in the student's "Your Work" section. This link will redirect the student to the same page that an instructor lands on when creating a new rubric, which will allow the student to create a review rubric just like an instructor does.
:[[File:Finaledit1r.png]]

*A link called "Supplemantary Review Questionnaire" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the link he/she can add the desired questions.
:[[File:rsz_link.png]]

* The page where student will be directed to when he/she clicks the Supplementary Review Questionnaire link.
:[[File:rsz_review.png]]

* The page which allows students to add different types of questions to the Supplementary Review Questionnaire.
:[[File:rsz_append.png]]

*Review Page
**When a reviewer fills out a rubric, the ResponseController will display a set of rubrics, in order, on the same page. This set would normally consist of just a review rubric, which is a Response object. However, the set would now have a review rubric and a supplementary review rubric (two items in the set instead of one) if the Supplementary Review rubric has been added. Thus, now the reviewer will be able to see the Supplementary Review questions along with the existing review questions.

*Review Results Page
**The “View” function for a rubric will display answers submitted for the SupplementaryReviewQuestionnaire as well as the ReviewQuestionnaire. We will add another column to the “View scores” page (for both instructor and students) so that the responses of the Supplementary Review Questions are also shown to student.
'''NOTE''':The student-generated questions (Supplementary Review Questions) will not be graded to avoid encouraging students to ask “easy” questions so that their reviewers would give them a high scores.

== Test Plan ==

Firstly, we need to add tests for the following:

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

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

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

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

'''Supplementary Review Questionnaire Testing : '''supplementary_review_rubric_spec.rb :
:In this test, we are testing the addition and editing of the supplementary questionnaire. Furthermore, we are also checking whether the questionnaire is being displayed or not to the reviewer. Also a test has been added to check if the questionnaire gets added to the model.
<pre>
include TopicHelper
describe "supplementary rubric testing" do
before(:each) do
# create assignment and topic
create(:assignment, name: "TestAssignment", directory_path: "TestAssignment")
create_list(:participant, 3)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).first, team: AssignmentTeam.first)
create(:topic, topic_name: "TestTopic")
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_questionnaire)
create(:questionnaire)
create(:question)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
end

it "has srq to add/edit supplementary questionnaire" do
signup_topic
expect(page).to have_content "Create Supplementary Review Questionnaire"
end

it "add supplementary questionnaire to teams model" do
signup_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
# assert !Team.supplementary_rubric_by_team_id(2).nil?
end

it "should display Supplementary Questionnaire to assigned student" do
submit_to_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
user = User.find_by(name: "student2066")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link "TestAssignment"
click_link "Others' work"
find(:css, "#i_dont_care").set(true)
click_button "Request a new submission to review"
click_link "Begin"
#expect(page).to have_content "Supplementary Reviewee Generated Questions"
end
end
</pre>

''' Topic Helper : '''topic_helper.rb :
:This file is included in the helper folder inside spec/features. This helper is used because the given methods are used in more than one place and to keep the code "DRY". In the first method we are stubbing the user so that that user signs up for an assignment. In the second method more testing is being performed to test the upload link.
<pre>
module TopicHelper
def signup_topic
user = User.find_by(name: "student2064")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
visit '/sign_up_sheet/sign_up?id=1&topic_id=1' # signup topic
visit '/student_task/list'
click_link "TestAssignment"
click_link "Your work"
end

def submit_to_topic
signup_topic
fill_in 'submission', with: "https://www.ncsu.edu"
click_on 'Upload link'
expect(page).to have_content "https://www.ncsu.edu"

end
end
</pre>

== File which are added/modified ==

As of now, we have figured out that the following files need to be added/modified:

1. '''app/models/supplementary_review_questionnaire.rb'''
*Added a migration to create a subclass "SupplementaryReviewQuestionnaire".

2. '''db/migrate/add_srq_id_to_teams.rb'''
*Added a migration which will add the Supplementary Review Questionnaire id column to the "Teams" table. This is to link the team which created the supplementary review questionnaire to the created questionnaire.

3. '''config/routes.rb'''
*To create Supplementary Review Questionnaire

4. '''app/controllers/response_controller.rb'''
* Obtained supplementary review questionnaire from the questionnaires table for new response
<pre>
def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@contributor.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

</pre>
* Obtained answers for the supplementary review questionnaire from the responses
<pre>
def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)
# added for srq
sr_answer = @response.scores.last
@sr_questionnaire = @response.questionnaire_by_answer(sr_answer)
end
</pre>
* Appended responses of the supplementary review questionnaire in the edit method
<pre>
def edit
@header = "Edit"
@next_action = "update"
@return = params[:return]
@response = Response.find(params[:id])
@map = @response.map
@contributor = @map.contributor
set_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i and m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content(new_response = true)
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
# added for srq
@sr_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
render action: 'response'
end
</pre>

* Append questions of supplementary review questionnaire in create method and set content method
<pre>
def create
map_id = params[:id]
map_id = params[:map_id] if !params[:map_id].nil?# pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
# added for srq
@team_id = @map.reviewee_id
set_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team_id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')

if params[:saved].nil? || params[:saved] == "0" # a flag so the autosave doesn't create different versions. The value's changed by the javascript in response.js
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round,
is_submitted: is_submitted
)
else
@response = Response.find_by(map_id: @map.id, round: @round)
if !@response.nil?
@response.update(additional_comment: params[:review][:comments]) # ignore if autoupdate try to save when the response object is not yet created.
else
logger.error("Can't find response with '#{@map.id}' and round '#{@round}' to update, even though params[:saved] = #{params[:saved]}")
end
end

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
sr_questions = sort_questions(@sr_questionnaire.questions)
questions += sr_questions
end
create_answers(params, questions) if params[:responses]

msg = "Your response was successfully saved."
error_msg = ""
# @response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
# @response.email
redirect_to controller: 'response', action: 'saving', id: @map.map_id, return: params[:return], msg: msg, error_msg: error_msg, save_options: params[:save_options]
end
</pre>
<pre>
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
@sr_questions = sort_questions(@sr_questionnaire.questions)
end
@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end
</pre>
5. '''app/controllers/grades_controller.rb'''
:Added supplementary review responses to "Your Scores" section.
<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
questionnaires.each do |questionnaire|
@round = if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
AssignmentQuestionnaire.find_by(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).used_in_round
end
vm = VmQuestionResponse.new(questionnaire, @assignment)
vmquestions = questionnaire.questions
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
unless @sr_questionnaire.nil?
sr_questions = @sr_questionnaire.questions
end
end
vmquestions += sr_questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>
6. '''app/views/assignments/edit/_rubrics.html.erb'''
*Add a checkbox called "Allow students to create supplementary review questionnaire" .
<pre>
<input name="assignment_form[assignment][srq]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][srq]', 'true', @assignment_form.assignment.srq) %>
<%= label_tag('assignment_form[assignment][srq]', 'Allow students to add Supplementary Review Questionnaire?') %>
</pre>

7. '''app/views/submitted_content/_main.html.erb'''
*Created a link " Create Supplementary Review Questionnaire" to appear in the student's "Your Work" section if the instructor has enabled student generated Questions for this assignment.
<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.srq? %>
<%= link_to "Create Supplementary Review Questionnaire", {:controller => "questionnaires", :action => "create_srq", :id => participant.id } %>
<% else %>
The instructor has not enabled this feature for this assignment
<% end %>
<% end %>
</pre>

8. '''app/controllers/questionnaires_controller'''
* Added a method to create Supplementary Review Questionnaire
<pre>
def create_srq
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.srq_id.nil? then
@questionnaire = Questionnaire.new
@questionnaire.private = false
@questionnaire.name = "SRQ_" + @team.id.to_s
@questionnaire.instructor_id = @team.id
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 5
@questionnaire.type = "SupplementaryReviewQuestionnaire"
@questionnaire.display_type = "SupplementaryReviewQuestionnaire"
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
@team.srq_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a questionnaire!'
else
@questionnaire = Questionnaire.find(@team.srq_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

</pre>

== Team members ==
::*Shrinath Cheriyana
::*Sanika Sabnis
::*Pratik Keny
::*Praneet Mocherla

== Links ==
*Expertiza on Github:https://github.com/Pratik2611/expertiza/tree/shrinathedit
*Expertiza YouTube channel: https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg/videos

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T03:25:55Z

Pkeny: /* Links */

== Introduction ==

=== Overview of Project ===

Expertiza contains Peer-Review where in all students are asked to review the work done by their fellow classmates. The rubric for the same are created by instructors. These Rubrics contain questions that are related to the submitted topics. But sometimes students have questions which may or may not be related to the work other students are working on. So there is no option currently available to ask these questions to their peers. This project (E1817) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

=== Proposed Solution ===

In order to solve the above problem, we intend to add Supplementary Review Questions to the existing Review Questions already added by the instructor. These “extra” questions will not be graded. However, they will increase the benefit that each person gets because they can get feedback that is specific to their project. The rest of this document describes the design and approach for project E1817.

== Implementation ==

In Expertiza, all rubrics and surveys are subclasses of Questionnaire. A Questionnaire has “questions” that make use of checkboxes, dropdowns, text boxes, etc. We want to add a new subclass of Questionnaire called SupplementaryReviewQuestionnaire to help us implement this project.

=== Design Strategy ===
The flowcharts below describes the design that we chose to implement for this project.

*When a student wants to create/edit Supplementary Review Questionnaire
** If the instructor has enabled a particular assignment to have supplementary review questionnaire only then a student can create a supplementary review questionnaire. A student can click on the "Your Work" tab and see a link to the add/edit Supplementary Review Questionnaire. This link directs the student to the create review questionnaire(same as instructor).
**When a student creates a Supplementary Review Questionnaire (SRQ), the entry in the SRQ column added to the Teams table will contain the questionnaire id to link the SRQ with the team that generated it. If the SRQ column of a team is empty it means no supplementary review questionnaire was created. If its not empty, it will indicate that a supplementary review questionnaire was created.

[[File:1flow.PNG]]

[[File:2flow.PNG]]

*When Reviewer wants to access the Review Questions.
** When a reviewer requests for a review, first the entry of the SRQ column in the Teams table is checked to see if supplementary review questionnaire was added. If the field is not empty, the supplementary review questionnaire is appended to the existing review questionnaire created by the instructor. Otherwise the reviewer only sees the default review questionnaire.

[[File:3flow.PNG]]

*When responses of questionnaire need to be displayed
** When the responses of the reviewer is recorded, the student can click on "View Scores" tab for a particular assignment which contains the responses of the reviewer. This view should contain the responses for both the default review questions as well the supplementary review questions added by the student. So if the entry of the SRQ column in the Teams table is not empty the responses of the supplementary review questions is appended to the responses of the default review questions.
'''NOTE''': The responses of the Supplementary Review Questions will not be added to the review scores of the project. It will just be shown to the team that has asked these questions so that they can see what suggestions does the reviewer has for the questions.

[[File:4flow.PNG]]

=== Changes in the User Interface ===

The following changes need to be made to the User Interface.

*Assignment Page
**An assignment will have a checkbox that the instructor can ‘check’ to enable a student to add supplementary review rubric. Once ‘checked’ a button or link will appear in the student's "Your Work" section. This link will redirect the student to the same page that an instructor lands on when creating a new rubric, which will allow the student to create a review rubric just like an instructor does.
:[[File:Finaledit1r.png]]

*A link called "Supplemantary Review Questionnaire" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the link he/she can add the desired questions.
:[[File:rsz_link.png]]

* The page where student will be directed to when he/she clicks the Supplementary Review Questionnaire link.
:[[File:rsz_review.png]]

* The page which allows students to add different types of questions to the Supplementary Review Questionnaire.
:[[File:rsz_append.png]]

*Review Page
**When a reviewer fills out a rubric, the ResponseController will display a set of rubrics, in order, on the same page. This set would normally consist of just a review rubric, which is a Response object. However, the set would now have a review rubric and a supplementary review rubric (two items in the set instead of one) if the Supplementary Review rubric has been added. Thus, now the reviewer will be able to see the Supplementary Review questions along with the existing review questions.

*Review Results Page
**The “View” function for a rubric will display answers submitted for the SupplementaryReviewQuestionnaire as well as the ReviewQuestionnaire. We will add another column to the “View scores” page (for both instructor and students) so that the responses of the Supplementary Review Questions are also shown to student.
'''NOTE''':The student-generated questions (Supplementary Review Questions) will not be graded to avoid encouraging students to ask “easy” questions so that their reviewers would give them a high scores.

== Test Plan ==

Firstly, we need to add tests for the following:

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

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

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

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

'''Supplementary Review Questionnaire Testing : '''supplementary_review_rubric_spec.rb :
:In this test, we are testing the addition and editing of the supplementary questionnaire. Furthermore, we are also checking whether the questionnaire is being displayed or not to the reviewer. Also a test has been added to check if the questionnaire gets added to the model.
<pre>
include TopicHelper
describe "supplementary rubric testing" do
before(:each) do
# create assignment and topic
create(:assignment, name: "TestAssignment", directory_path: "TestAssignment")
create_list(:participant, 3)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).first, team: AssignmentTeam.first)
create(:topic, topic_name: "TestTopic")
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_questionnaire)
create(:questionnaire)
create(:question)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
end

it "has srq to add/edit supplementary questionnaire" do
signup_topic
expect(page).to have_content "Create Supplementary Review Questionnaire"
end

it "add supplementary questionnaire to teams model" do
signup_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
# assert !Team.supplementary_rubric_by_team_id(2).nil?
end

it "should display Supplementary Questionnaire to assigned student" do
submit_to_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
user = User.find_by(name: "student2066")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link "TestAssignment"
click_link "Others' work"
find(:css, "#i_dont_care").set(true)
click_button "Request a new submission to review"
click_link "Begin"
#expect(page).to have_content "Supplementary Reviewee Generated Questions"
end
end
</pre>

''' Topic Helper : '''topic_helper.rb :
:This file is included in the helper folder inside spec/features. This helper is used because the given methods are used in more than one place and to keep the code "DRY". In the first method we are stubbing the user so that that user signs up for an assignment. In the second method more testing is being performed to test the upload link.
<pre>
module TopicHelper
def signup_topic
user = User.find_by(name: "student2064")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
visit '/sign_up_sheet/sign_up?id=1&topic_id=1' # signup topic
visit '/student_task/list'
click_link "TestAssignment"
click_link "Your work"
end

def submit_to_topic
signup_topic
fill_in 'submission', with: "https://www.ncsu.edu"
click_on 'Upload link'
expect(page).to have_content "https://www.ncsu.edu"

end
end
</pre>

== File which are added/modified ==

As of now, we have figured out that the following files need to be added/modified:

1. '''app/models/supplementary_review_questionnaire.rb'''
*Added a migration to create a subclass "SupplementaryReviewQuestionnaire".

2. '''db/migrate/add_srq_id_to_teams.rb'''
*Added a migration which will add the Supplementary Review Questionnaire id column to the "Teams" table. This is to link the team which created the supplementary review questionnaire to the created questionnaire.

3. '''config/routes.rb'''
*To create Supplementary Review Questionnaire

4. '''app/controllers/response_controller.rb'''
* Obtained supplementary review questionnaire from the questionnaires table for new response
<pre>
def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@contributor.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

</pre>
* Obtained answers for the supplementary review questionnaire from the responses
<pre>
def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)
# added for srq
sr_answer = @response.scores.last
@sr_questionnaire = @response.questionnaire_by_answer(sr_answer)
end
</pre>
* Appended responses of the supplementary review questionnaire in the edit method
<pre>
def edit
@header = "Edit"
@next_action = "update"
@return = params[:return]
@response = Response.find(params[:id])
@map = @response.map
@contributor = @map.contributor
set_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i and m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content(new_response = true)
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
# added for srq
@sr_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
render action: 'response'
end
</pre>

* Append questions of supplementary review questionnaire in create method and set content method
<pre>
def create
map_id = params[:id]
map_id = params[:map_id] if !params[:map_id].nil?# pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
# added for srq
@team_id = @map.reviewee_id
set_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team_id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')

if params[:saved].nil? || params[:saved] == "0" # a flag so the autosave doesn't create different versions. The value's changed by the javascript in response.js
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round,
is_submitted: is_submitted
)
else
@response = Response.find_by(map_id: @map.id, round: @round)
if !@response.nil?
@response.update(additional_comment: params[:review][:comments]) # ignore if autoupdate try to save when the response object is not yet created.
else
logger.error("Can't find response with '#{@map.id}' and round '#{@round}' to update, even though params[:saved] = #{params[:saved]}")
end
end

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
sr_questions = sort_questions(@sr_questionnaire.questions)
questions += sr_questions
end
create_answers(params, questions) if params[:responses]

msg = "Your response was successfully saved."
error_msg = ""
# @response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
# @response.email
redirect_to controller: 'response', action: 'saving', id: @map.map_id, return: params[:return], msg: msg, error_msg: error_msg, save_options: params[:save_options]
end
</pre>
<pre>
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
@sr_questions = sort_questions(@sr_questionnaire.questions)
end
@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end
</pre>
5. '''app/controllers/grades_controller.rb'''
:Added supplementary review responses to "Your Scores" section.
<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
questionnaires.each do |questionnaire|
@round = if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
AssignmentQuestionnaire.find_by(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).used_in_round
end
vm = VmQuestionResponse.new(questionnaire, @assignment)
vmquestions = questionnaire.questions
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
unless @sr_questionnaire.nil?
sr_questions = @sr_questionnaire.questions
end
end
vmquestions += sr_questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>
6. '''app/views/assignments/edit/_rubrics.html.erb'''
*Add a checkbox called "Allow students to create supplementary review questionnaire" .
<pre>
<input name="assignment_form[assignment][srq]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][srq]', 'true', @assignment_form.assignment.srq) %>
<%= label_tag('assignment_form[assignment][srq]', 'Allow students to add Supplementary Review Questionnaire?') %>
</pre>

7. '''app/views/submitted_content/_main.html.erb'''
*Created a link " Create Supplementary Review Questionnaire" to appear in the student's "Your Work" section if the instructor has enabled student generated Questions for this assignment.
<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.srq? %>
<%= link_to "Create Supplementary Review Questionnaire", {:controller => "questionnaires", :action => "create_srq", :id => participant.id } %>
<% else %>
The instructor has not enabled this feature for this assignment
<% end %>
<% end %>
</pre>

8. '''app/controllers/questionnaires_controller'''
* Added a method to create Supplementary Review Questionnaire
<pre>
def create_srq
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.srq_id.nil? then
@questionnaire = Questionnaire.new
@questionnaire.private = false
@questionnaire.name = "SRQ_" + @team.id.to_s
@questionnaire.instructor_id = @team.id
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 5
@questionnaire.type = "SupplementaryReviewQuestionnaire"
@questionnaire.display_type = "SupplementaryReviewQuestionnaire"
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
@team.srq_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a questionnaire!'
else
@questionnaire = Questionnaire.find(@team.srq_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

</pre>

== Team members ==
Shrinath Cheriyana
Sanika Sabnis
Pratik Keny
Praneet Mocherla

== Links ==
*Expertiza on Github:https://github.com/Pratik2611/expertiza/tree/shrinathedit
*Expertiza YouTube channel: https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg/videos

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T03:24:24Z

Pkeny: /* Test Plan */

== Introduction ==

=== Overview of Project ===

Expertiza contains Peer-Review where in all students are asked to review the work done by their fellow classmates. The rubric for the same are created by instructors. These Rubrics contain questions that are related to the submitted topics. But sometimes students have questions which may or may not be related to the work other students are working on. So there is no option currently available to ask these questions to their peers. This project (E1817) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

=== Proposed Solution ===

In order to solve the above problem, we intend to add Supplementary Review Questions to the existing Review Questions already added by the instructor. These “extra” questions will not be graded. However, they will increase the benefit that each person gets because they can get feedback that is specific to their project. The rest of this document describes the design and approach for project E1817.

== Implementation ==

In Expertiza, all rubrics and surveys are subclasses of Questionnaire. A Questionnaire has “questions” that make use of checkboxes, dropdowns, text boxes, etc. We want to add a new subclass of Questionnaire called SupplementaryReviewQuestionnaire to help us implement this project.

=== Design Strategy ===
The flowcharts below describes the design that we chose to implement for this project.

*When a student wants to create/edit Supplementary Review Questionnaire
** If the instructor has enabled a particular assignment to have supplementary review questionnaire only then a student can create a supplementary review questionnaire. A student can click on the "Your Work" tab and see a link to the add/edit Supplementary Review Questionnaire. This link directs the student to the create review questionnaire(same as instructor).
**When a student creates a Supplementary Review Questionnaire (SRQ), the entry in the SRQ column added to the Teams table will contain the questionnaire id to link the SRQ with the team that generated it. If the SRQ column of a team is empty it means no supplementary review questionnaire was created. If its not empty, it will indicate that a supplementary review questionnaire was created.

[[File:1flow.PNG]]

[[File:2flow.PNG]]

*When Reviewer wants to access the Review Questions.
** When a reviewer requests for a review, first the entry of the SRQ column in the Teams table is checked to see if supplementary review questionnaire was added. If the field is not empty, the supplementary review questionnaire is appended to the existing review questionnaire created by the instructor. Otherwise the reviewer only sees the default review questionnaire.

[[File:3flow.PNG]]

*When responses of questionnaire need to be displayed
** When the responses of the reviewer is recorded, the student can click on "View Scores" tab for a particular assignment which contains the responses of the reviewer. This view should contain the responses for both the default review questions as well the supplementary review questions added by the student. So if the entry of the SRQ column in the Teams table is not empty the responses of the supplementary review questions is appended to the responses of the default review questions.
'''NOTE''': The responses of the Supplementary Review Questions will not be added to the review scores of the project. It will just be shown to the team that has asked these questions so that they can see what suggestions does the reviewer has for the questions.

[[File:4flow.PNG]]

=== Changes in the User Interface ===

The following changes need to be made to the User Interface.

*Assignment Page
**An assignment will have a checkbox that the instructor can ‘check’ to enable a student to add supplementary review rubric. Once ‘checked’ a button or link will appear in the student's "Your Work" section. This link will redirect the student to the same page that an instructor lands on when creating a new rubric, which will allow the student to create a review rubric just like an instructor does.
:[[File:Finaledit1r.png]]

*A link called "Supplemantary Review Questionnaire" will appear in the student's "Your Work" section when the Instructor has allowed students to create supplementary review questions. So when a student clicks the link he/she can add the desired questions.
:[[File:rsz_link.png]]

* The page where student will be directed to when he/she clicks the Supplementary Review Questionnaire link.
:[[File:rsz_review.png]]

* The page which allows students to add different types of questions to the Supplementary Review Questionnaire.
:[[File:rsz_append.png]]

*Review Page
**When a reviewer fills out a rubric, the ResponseController will display a set of rubrics, in order, on the same page. This set would normally consist of just a review rubric, which is a Response object. However, the set would now have a review rubric and a supplementary review rubric (two items in the set instead of one) if the Supplementary Review rubric has been added. Thus, now the reviewer will be able to see the Supplementary Review questions along with the existing review questions.

*Review Results Page
**The “View” function for a rubric will display answers submitted for the SupplementaryReviewQuestionnaire as well as the ReviewQuestionnaire. We will add another column to the “View scores” page (for both instructor and students) so that the responses of the Supplementary Review Questions are also shown to student.
'''NOTE''':The student-generated questions (Supplementary Review Questions) will not be graded to avoid encouraging students to ask “easy” questions so that their reviewers would give them a high scores.

== Test Plan ==

Firstly, we need to add tests for the following:

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

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

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

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

'''Supplementary Review Questionnaire Testing : '''supplementary_review_rubric_spec.rb :
:In this test, we are testing the addition and editing of the supplementary questionnaire. Furthermore, we are also checking whether the questionnaire is being displayed or not to the reviewer. Also a test has been added to check if the questionnaire gets added to the model.
<pre>
include TopicHelper
describe "supplementary rubric testing" do
before(:each) do
# create assignment and topic
create(:assignment, name: "TestAssignment", directory_path: "TestAssignment")
create_list(:participant, 3)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).first, team: AssignmentTeam.first)
create(:topic, topic_name: "TestTopic")
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_questionnaire)
create(:questionnaire)
create(:question)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
end

it "has srq to add/edit supplementary questionnaire" do
signup_topic
expect(page).to have_content "Create Supplementary Review Questionnaire"
end

it "add supplementary questionnaire to teams model" do
signup_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
# assert !Team.supplementary_rubric_by_team_id(2).nil?
end

it "should display Supplementary Questionnaire to assigned student" do
submit_to_topic
click_link "Create Supplementary Review Questionnaire"
click_button "Add"
click_button "Save supplementaryreview questionnaire"
user = User.find_by(name: "student2066")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
click_link "TestAssignment"
click_link "Others' work"
find(:css, "#i_dont_care").set(true)
click_button "Request a new submission to review"
click_link "Begin"
#expect(page).to have_content "Supplementary Reviewee Generated Questions"
end
end
</pre>

''' Topic Helper : '''topic_helper.rb :
:This file is included in the helper folder inside spec/features. This helper is used because the given methods are used in more than one place and to keep the code "DRY". In the first method we are stubbing the user so that that user signs up for an assignment. In the second method more testing is being performed to test the upload link.
<pre>
module TopicHelper
def signup_topic
user = User.find_by(name: "student2064")
stub_current_user(user, user.role.name, user.role)
visit '/student_task/list'
visit '/sign_up_sheet/sign_up?id=1&topic_id=1' # signup topic
visit '/student_task/list'
click_link "TestAssignment"
click_link "Your work"
end

def submit_to_topic
signup_topic
fill_in 'submission', with: "https://www.ncsu.edu"
click_on 'Upload link'
expect(page).to have_content "https://www.ncsu.edu"

end
end
</pre>

== File which are added/modified ==

As of now, we have figured out that the following files need to be added/modified:

1. '''app/models/supplementary_review_questionnaire.rb'''
*Added a migration to create a subclass "SupplementaryReviewQuestionnaire".

2. '''db/migrate/add_srq_id_to_teams.rb'''
*Added a migration which will add the Supplementary Review Questionnaire id column to the "Teams" table. This is to link the team which created the supplementary review questionnaire to the created questionnaire.

3. '''config/routes.rb'''
*To create Supplementary Review Questionnaire

4. '''app/controllers/response_controller.rb'''
* Obtained supplementary review questionnaire from the questionnaires table for new response
<pre>
def set_questionnaire_for_new_response
case @map.type
when "ReviewResponseMap", "SelfReviewResponseMap"
reviewees_topic = SignedUpTeam.topic_id_by_team_id(@contributor.id)
@current_round = @assignment.number_of_current_round(reviewees_topic)
@questionnaire = @map.questionnaire(@current_round)
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@contributor.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
when
"MetareviewResponseMap",
"TeammateReviewResponseMap",
"FeedbackResponseMap",
"CourseSurveyResponseMap",
"AssignmentSurveyResponseMap",
"GlobalSurveyResponseMap"
@questionnaire = @map.questionnaire
end
end

</pre>
* Obtained answers for the supplementary review questionnaire from the responses
<pre>
def set_questionnaire
# if user is not filling a new rubric, the @response object should be available.
# we can find the questionnaire from the question_id in answers
answer = @response.scores.first
@questionnaire = @response.questionnaire_by_answer(answer)
# added for srq
sr_answer = @response.scores.last
@sr_questionnaire = @response.questionnaire_by_answer(sr_answer)
end
</pre>
* Appended responses of the supplementary review questionnaire in the edit method
<pre>
def edit
@header = "Edit"
@next_action = "update"
@return = params[:return]
@response = Response.find(params[:id])
@map = @response.map
@contributor = @map.contributor
set_all_responses
if @prev.present?
@sorted = @review_scores.sort {|m1, m2| m1.version_num.to_i and m2.version_num.to_i ? m2.version_num.to_i <=> m1.version_num.to_i : (m1.version_num ? -1 : 1) }
@largest_version_num = @sorted[0]
end
@modified_object = @response.response_id
# set more handy variables for the view
set_content(new_response = true)
@review_scores = []
@questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
# added for srq
@sr_questions.each do |question|
@review_scores << Answer.where(response_id: @response.response_id, question_id: question.id).first
end
render action: 'response'
end
</pre>

* Append questions of supplementary review questionnaire in create method and set content method
<pre>
def create
map_id = params[:id]
map_id = params[:map_id] if !params[:map_id].nil?# pass map_id as a hidden field in the review form
@map = ResponseMap.find(map_id)
# added for srq
@team_id = @map.reviewee_id
set_all_responses
if params[:review][:questionnaire_id]
@questionnaire = Questionnaire.find(params[:review][:questionnaire_id])
@round = params[:review][:round]
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team_id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
end
else
@round = nil
end
is_submitted = (params[:isSubmit] == 'Yes')

if params[:saved].nil? || params[:saved] == "0" # a flag so the autosave doesn't create different versions. The value's changed by the javascript in response.js
@response = Response.create(
map_id: @map.id,
additional_comment: params[:review][:comments],
round: @round,
is_submitted: is_submitted
)
else
@response = Response.find_by(map_id: @map.id, round: @round)
if !@response.nil?
@response.update(additional_comment: params[:review][:comments]) # ignore if autoupdate try to save when the response object is not yet created.
else
logger.error("Can't find response with '#{@map.id}' and round '#{@round}' to update, even though params[:saved] = #{params[:saved]}")
end
end

# ,:version_num=>@version)
# Change the order for displaying questions for editing response views.
questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
sr_questions = sort_questions(@sr_questionnaire.questions)
questions += sr_questions
end
create_answers(params, questions) if params[:responses]

msg = "Your response was successfully saved."
error_msg = ""
# @response.notify_instructor_on_difference if (@map.is_a? ReviewResponseMap) && @response.is_submitted && @response.significant_difference?
# @response.email
redirect_to controller: 'response', action: 'saving', id: @map.map_id, return: params[:return], msg: msg, error_msg: error_msg, save_options: params[:save_options]
end
</pre>
<pre>
def set_content(new_response = false)
@title = @map.get_title
if @map.survey?
@survey_parent = @map.survey_parent
else
@assignment = @map.assignment
end
@participant = @map.reviewer
@contributor = @map.contributor
new_response ? set_questionnaire_for_new_response : set_questionnaire
set_dropdown_or_scale
@questions = sort_questions(@questionnaire.questions)
# added for srq
unless @sr_questionnaire.nil?
@sr_questions = sort_questions(@sr_questionnaire.questions)
end
@min = @questionnaire.min_question_score
@max = @questionnaire.max_question_score
end
</pre>
5. '''app/controllers/grades_controller.rb'''
:Added supplementary review responses to "Your Scores" section.
<pre>
def view_team
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@team = @participant.team
@team_id = @team.id
@questions = {}
questionnaires = @assignment.questionnaires
retrieve_questions questionnaires
@pscore = @participant.scores(@questions)
@vmlist = []

# loop through each questionnaire, and populate the view model for all data necessary
# to render the html tables.
questionnaires.each do |questionnaire|
@round = if @assignment.varying_rubrics_by_round? && questionnaire.type == "ReviewQuestionnaire"
AssignmentQuestionnaire.find_by(assignment_id: @assignment.id, questionnaire_id: questionnaire.id).used_in_round
end
vm = VmQuestionResponse.new(questionnaire, @assignment)
vmquestions = questionnaire.questions
# added for srq
@sr_questionnaire_id = Team.get_srq_id_of_team(@team.id)
unless @sr_questionnaire_id.nil?
@sr_questionnaire = Questionnaire.find(@sr_questionnaire_id)
unless @sr_questionnaire.nil?
sr_questions = @sr_questionnaire.questions
end
end
vmquestions += sr_questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.varying_rubrics_by_round?)
vm.get_number_of_comments_greater_than_10_words
@vmlist << vm
end
@current_role_name = current_role_name
end
</pre>
6. '''app/views/assignments/edit/_rubrics.html.erb'''
*Add a checkbox called "Allow students to create supplementary review questionnaire" .
<pre>
<input name="assignment_form[assignment][srq]" type="hidden" value="false"/>
<%= check_box_tag('assignment_form[assignment][srq]', 'true', @assignment_form.assignment.srq) %>
<%= label_tag('assignment_form[assignment][srq]', 'Allow students to add Supplementary Review Questionnaire?') %>
</pre>

7. '''app/views/submitted_content/_main.html.erb'''
*Created a link " Create Supplementary Review Questionnaire" to appear in the student's "Your Work" section if the instructor has enabled student generated Questions for this assignment.
<pre>
<% if stage != "Finished" and controller.controller_name == 'submitted_content' and @can_submit %>
<h2>Add Supplementary Review Questions:</h2>
<% if @assignment.srq? %>
<%= link_to "Create Supplementary Review Questionnaire", {:controller => "questionnaires", :action => "create_srq", :id => participant.id } %>
<% else %>
The instructor has not enabled this feature for this assignment
<% end %>
<% end %>
</pre>

8. '''app/controllers/questionnaires_controller'''
* Added a method to create Supplementary Review Questionnaire
<pre>
def create_srq
@participant = AssignmentParticipant.find(params[:id])
@team = Team.find(@participant.team.id)
if @team.srq_id.nil? then
@questionnaire = Questionnaire.new
@questionnaire.private = false
@questionnaire.name = "SRQ_" + @team.id.to_s
@questionnaire.instructor_id = @team.id
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 5
@questionnaire.type = "SupplementaryReviewQuestionnaire"
@questionnaire.display_type = "SupplementaryReviewQuestionnaire"
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
@team.srq_id = @questionnaire.id
@team.save
flash[:success] = 'You have successfully created a questionnaire!'
else
@questionnaire = Questionnaire.find(@team.srq_id)
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

</pre>

== Links ==
*Expertiza on Github:https://github.com/Pratik2611/expertiza/tree/shrinathedit
*Expertiza YouTube channel: https://www.youtube.com/channel/UCdKXzox7hrWjfOMML6FzTWg/videos

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:50:03Z

Pkeny: /* File that will be added/modified */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:43:22Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:42:52Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:39:59Z

Pkeny: /* References */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:37:18Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:36:24Z

Pkeny: /* File that will be added/modified */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:32:11Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:28:20Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:25:14Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:24:50Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:22:33Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-29T02:22:01Z

Pkeny: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric

2018-04-09T01:44:52Z

Pkeny: /* Test Plan */

== Introduction ==
== Overview of Project ==

Expertiza contains Peer-Review where in all students are asked to review the work done by their fellow classmates. The rubric for the same are created by instructors. These Rubrics contain questions that are related to the submitted topics. But sometimes students have questions which may or may not be related to the work other students are working on. So there is no option currently available to ask these questions to their peers. This project (E1817) aims to solve this problem by allowing students to add questions to the standard instructor generated rubric so that they can get specific feedback on from the reviewers.

== Proposed Solution ==

In order to solve the above problem, we intend to add a Supplementary Review Questions to the existing Review Questions already added by the instructor. These “extra” questions will not be graded. However, they will increase the benefit that each person gets because they can get feedback that is specific to their project. The rest of this document describes the design and approach for project E1817.

== Implementation ==

In Expertiza, all rubrics and surveys are subclasses of Questionnaire. A Questionnaire has “questions” that make use of checkboxes, dropdowns, text boxes, etc. We want to add a new subclass of Questionnaire called SupplementaryReviewQuestionnaire to help us implement this project.

=== Design Strategy ===
The flowchart below describes the design that we chose to implement for this project.

*When a student wants to create/edit Supplementary Review Questionnaire
** If the instructor has enabled a particular assignment to have supplementary review questionnaire a student when clicks on the "Your Work" tab sees a link to the add/edit Supplemntary Review Questionnaire. This link directs the student to the create review questionnaire(same as instructor).
**When a student creates a Supplementary Review Questionnaire(SRQ), a SRQ column needs to be added to the Teams Table which will contain the questionnaire id to link the SRQ with the team that generated it. If the SRQ column of a team is empty it means no supplementary review questionnaire was created. If its not empty, it will indicate that a supplementary review questionnaire was created.

[[File:Flow1edited.PNG]]

*When Reviewer wants to access the Review Questions.
** When a reviewer requests for a review, first the entry of the SRQ column in the Teams table is checked to see if supplementary review questionnaire was added. If the field is not empty, the supplementary review questionnaire is appended to the existing review questionnaire created by the instructor. Otherwise the reviewer only sees the default review questionnaire.
[[File:Flow2edited.PNG]]

*When scores need to be displayed
** When the response of the reviewer is recorded, the student can view the scores for a particular assignment which contains the response of the review questions. This view should contain both the scores of default review questions as well the supplementary review questions added by the student. So if the SRQ field in the Teams table is not empty the scores of the supplementary review questions is appended to the scores of the default review questions.
[[File:Flow3edited.PNG]]

=== Changes in the UserInterface ===

To be able to achieve the goal for this project, we need to implement some changes in the UI.
*Assignment Page
**An assignment will have a checkbox that the instructor can ‘check’ to enable a supplementary review rubric. Once ‘checked’ a button or link on the page will appear. This button will take the student to the same page that an instructor lands on when creating a new rubric, which will allow the student to create a review rubric just like an instructor does.
*A link needs to be added to the submission of the work. So when a student clicks the link he/she can add the desired questions.
:[[File:rsz_link.png]]

* The page where student will be directed to when he/she clicks the Supplementary Review Questionnaire link.
:[[File:rsz_review.png]]

* The page which allows students to add different types of questions to the Supplementary Review Questionnaire.
:[[File:rsz_append.png]]

*Review Page
**When a reviewer fills out a rubric, the ResponseController will display a set of rubrics, in order, on the same page. This set would normally consist of just a review rubric, which is a Response object. However, the set would now have a review rubric and a supplementary review rubric (two items in the set instead of one) if supplementary Review rubric has been added.

*Review Results Page
**The “View” function for a rubric will display answers submitted for the SupplementaryReviewQuestionnaire as well as the ReviewQuestionnaire. We will also add another column to the “View scores” page (for both instructor and students) to report the scores that the students gave on these questions. The student-generated questions will not be graded to avoid encouraging students to ask “easy” questions so that their reviewers would give them a high scores.

== Test Plan ==

Firstly, we need to add tests for the following:

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

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

3. To check if after creation of the supplementary questionnaire the supplementary questionnaire column of the Teams table has correct value (i.e not NIL).

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

Apart from these we will need to add some tests to '''assignments_spec''' and '''response_controller_spec''' to test the addition of Supplementary Review Questionnaire.

== File that will be added/modified ==

As of now, we have figured out that the following files need to be added/modified:

1. '''app/models/supplementary_review_questionnaire.rb'''
:We need to create a subclass "SupplementaryQuestionnaire".

2. '''db/migrate/Add_Supplementary_Questionnaire_to_Teams.rb'''
:We need to add to create a migration which will add the Supplementary Questionnaire column to the "Teams" table.

3. '''config/routes.rb'''
:For correct switching between the various views

4. '''app/controllers/student_review_controller.rb, app/controllers/review_mapping_controller.rb, app/controllers/response_controller.rb'''
:Files that need modification for adding Supplementary questions to the existing rubrics.

5. '''spec/models/assignment_spec.rb'''
:Add additional test case to test the new functionality.

6. '''spec/controllers/response_controller_spec.rb'''
:Add additional test case to test the new functionality.

'''NOTE''' : There will be additional files that need modification and some new files may also need to be added the above given list is temporary.

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

2018-04-03T18:12:40Z

Pkeny: /* Implementation */

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

==== '''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-03T18:11:17Z

Pkeny: /* Implementation */

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

==== '''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-03T18:10:52Z

Pkeny: /* Implementation */

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

==== '''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-03T18:09:52Z

Pkeny: /* Further Implementation Required */

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

==== '''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-03T18:04:21Z

Pkeny: /* Further Implementation Required */

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''' ====
::*Automatic testing

==== '''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-03T02:32:42Z

Pkeny: /* Important links */

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/assignments_controller_spec.rb
* 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''' =====
===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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-03T02:30:38Z

Pkeny: /* UI Testing */

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/assignments_controller_spec.rb
* 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''' =====
===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:Rsz 1capturestu 3.png

2018-04-03T02:30:15Z

Pkeny:

File:Rsz capturesugg comm.png

2018-04-03T02:29:28Z

Pkeny:

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

2018-04-03T02:27:24Z

Pkeny: /* UI Testing */

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/assignments_controller_spec.rb
* 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''' =====
===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Rsz_capturestu_1.png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Capture(stu_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:File-Capture(sugg 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-03T02:25:50Z

Pkeny: /* UI Testing */

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/assignments_controller_spec.rb
* 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''' =====
===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Rsz_Capture(stu_1).png|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Capture(stu_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:File-Capture(sugg 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:Rsz capturestu 2.png

2018-04-03T02:24:56Z

Pkeny:

File:Rsz capturestu 1.png

2018-04-03T02:24:32Z

Pkeny:

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

2018-04-03T02:20:39Z

Pkeny: /* UI Testing */

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/assignments_controller_spec.rb
* 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''' =====
===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Capture(stu_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:File-Capture(sugg comm).PNG|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Rsz_captureaedit.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:Rsz captureedit.png

2018-04-03T02:19:58Z

Pkeny:

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

2018-04-03T02:18:40Z

Pkeny: /* UI Testing */

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/assignments_controller_spec.rb
* 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''' =====
===== '''Add topic''' =====
===== '''Delete topic''' =====
===== '''Edit topic''' =====
===== '''Navigate to finished assignment''' =====
===== '''Sign up for a topic as a student''' =====

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Capture(stu_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:File-Capture(sugg comm).PNG|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Capture(edit).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:Rsz capturea.png

2018-04-03T02:18:07Z

Pkeny:

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

2018-04-03T00:17:04Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::''''3. Add your suggestion.''''
[[File:Capture(stu_3).PNG|frame|center|x|]]
::''''4. Login as instructor6 and password:password.''''
::''''5. Go to assignments and search for "wiki textbook".''''
[[File:Capture(a).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:File-Capture(sugg comm).PNG|frame|center|x|]]
::''''8. Can edit the comment by clicking on the "Edit Comment" button.''''
[[File:Capture(edit).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-03T00:15:50Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|frame|center|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).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:File-Capture(sugg comm).PNG|frame|center|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).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-03T00:15:01Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|frame|center|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).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:File-Capture(sugg comm).PNG|frame|center|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).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-03T00:13:39Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|frame|center|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).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:File-Capture(sugg comm).PNG|frame|center|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).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-03T00:12:56Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|x|x|]]

[[File:Capture(stu_2).PNG|frame|x|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|frame|x|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG|frame|x|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:File-Capture(sugg comm).PNG|frame|x|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG|frame|x|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-03T00:11:39Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|frame|center|x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|frame|center|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).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:File-Capture(sugg comm).PNG|frame|center|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).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-03T00:10:59Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|50x|]]

[[File:Capture(stu_2).PNG|frame|center|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG|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:File-Capture(sugg comm).PNG|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG|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-03T00:07:42Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|50x|]]

[[File:Capture(stu_2).PNG|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG|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:File-Capture(sugg comm).PNG|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG|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-03T00:06:41Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|50px|]]

[[File:Capture(stu_2).PNG|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG|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:File-Capture(sugg comm).PNG|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG|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-03T00:05:06Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|xpx|]]

[[File:Capture(stu_2).PNG|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG|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:File-Capture(sugg comm).PNG|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG|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-03T00:04:50Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|x,px|]]

[[File:Capture(stu_2).PNG|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG|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:File-Capture(sugg comm).PNG|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG|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-03T00:04:09Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|x|]]

[[File:Capture(stu_2).PNG|x|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG|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:File-Capture(sugg comm).PNG|x|]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG|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-03T00:03:36Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|5x|]]

[[File:Capture(stu_2).PNG|x8px|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|10x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG]]
::6. Click on the "view suggestion" icon on the right side of the screen
::7. Add a comment on that suggestion and submit
[[File:File-Capture(sugg comm).PNG]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG]]
::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-03T00:03:12Z

Pkeny: /* UI Testing */

This page provides a description of our Expertiza project.

__TOC__

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

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

== 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/assignments_controller_spec.rb
* 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.

==== '''Further Implementation Required''' ====
::There is logic implemented in the views that needs to be moved back to the controller. This logic deals with conditional display of fields based on the current role of the user or status of the assignment. Additional tests need to be created to test this controller logic.

==== '''Testing''' ====
===== '''UI Testing''' =====
::The tests were written in these files:
::*app/spec/controllers/assignments_controller_spec.rb
::*app/spec/controllers/sign_up_sheet_controller_spec.rb
::As mentioned previously they are still a work in progress. You can run the tests that were made by running these rspec files.

===== '''Automatic Testing''' =====
'''Testing is still in progress. After a merge, aspects of the code need to be changed.'''

::For testing the newly created JSGrid, it is important to ensure it maintains correct functionality from before. To that end, we created quite a few tests that test manage topic functionality.
::* Testing that if an assignment due date has passed:
::**Topics are no longer editable and you can no longer add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>
context 'assignment due dates have not passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone + 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'allows a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:edit)
end

it 'allows a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:destroy)
end

it 'allows a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).to respond_to(:new)
end
end

</pre>
::* Testing that if an assignment due date has not passed:
::**Topics are editable and you can add/delete topics
::'''app/spec/controllers/assignments_controller_spec.rb'''
<pre>

context 'all assignment due dates have passed' do
before(:each) do
due_date.due_at = DateTime.now.in_time_zone - 1.day
allow(assignment.due_dates).to receive(:find_by).with(deadline_type_id: 6).and_return(due_date)
end
it 'does not allow a topic to be edited' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:edit)
end

it 'does not allow a topic to be deleted' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:destroy)
end

it 'does not allow a new topic to be added' do
params = {id: 1, anchor: 'tabs-2'}
get :edit, params, xhr: true
expect(response).not_to respond_to(:new)
end
end

</pre>
::* Testing that default topic available slots is 1
::'''app/spec/controllers/sign_up_sheet_controller_spec.rb'''
<pre>
define '#new' do
it 'has default available slots of 1' do
params = {id: 1}
get :new, params
expect(response).to have_field('max_choosers', with: '1')
end
end

</pre>

==== '''Further Testing Required''' ====
::Unfortunately we were unable to exhaustively test the topic table, but here are the things we plan to test about managing topics over the next week:
::*If assignment deadline has passed, you can not add students to a topic
::*Ensure students cant see which students are on other topics
::*Check that Advertisement Horn shows in the table if a team has an ad open
::*If you login as student, you can't add/delete topics in the table

== 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:File-Capture(stu_1).PNG|8px|]]

[[File:Capture(stu_2).PNG|x8px|]]
::3. Add your suggestion
[[File:Capture(stu_3).PNG|10x|]]
::4. Login as instructor6 and password:password
::5. Go to assignments and search for "wiki textbook"
[[File:Capture(a).PNG]]
::6. Click on the "view suggestion" icon on the right side of the screen
::7. Add a comment on that suggestion and submit
[[File:File-Capture(sugg comm).PNG]]
::8. Can edit the comment by clicking on the "Edit Comment" button.
[[File:Capture(edit).PNG]]
::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.