Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2018-11-13T22:39:28Z

Mjain6: /* References */

='''Problem Statement'''=
A key component of Expertiza is peer reviews, which provide feedback to authors so that they can improve their work. Expertiza also supports grading of these reviews to ensure students write quality reviews, helping them learn more about the assignment by looking at their peers' work. In addition, Expertiza allows for metareviews, which are reviews the authors of the original work write for the reviews of their original work. This author feedback is useful for grading the reviews because it indicates how helpful this review was to the authors of the original work. The objective of this project is to add metareview or author feedback information to the review report page, which shows a summary of all the reviews written by the students for an assignment.

='''Goal'''=

The aim of this project is to build this into the system. We need an additional column in the 'Review Report' page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

='''Design'''=

== User Interface Enhancements ==

In the page "Review report for Design exercise" (Log in as an instructor then go to Manage -> Assignments -> View review report.), we are planning to add one more column to show the average ratings for the author feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column. Below is the page we are planning to edit.

[[File:Feedback_new.png]]

== Controller-level Logic ==

The following method shows the code logic we are planning to write for calculating the average scores for the feedback given by authors for the reviews of their work.

<pre style="color: black; border:1px;">
def calculate_avg_score_by_feedback(question_answers, q_max_score)
# get score and summary of answers for each question
# only include divide the valid_answer_sum with the number of valid answers

valid_answer_counter = 0
question_score = 0.0
question_answers.each do |ans|
# calculate score per question
unless ans.answer.nil?
question_score += ans.answer
valid_answer_counter += 1
end
end

if valid_answer_counter > 0 and q_max_score > 0
# convert the score in percentage
question_score /= (valid_answer_counter * q_max_score)
question_score = question_score.round(2) * 100
end

question_score
end

</pre>

== Relevant Database Tables ==

The following are the table structures we will need for this feature. First, the questions table has all the questions based on the questionnaire. We will be only concerned with the questions in the feedback questionnaire. The answers for each question in the feedback questionnaire are saved in the Answers table below based on the Question ID. Now, in order to know if the answer is a feedback by team members or a review by reviewer, the mapping for the Answers table is done by the response_id which is a foreign key to the Response table. This Response table gives us the map_id which maps to a response map table. Now, the response map table gives us information on the reviewer_id, reviewee_id, reviewed_object_id (which is the ID for the assignment being reviewed) and the type (whether it's a teammate review, author feedback, a regular review, etc.). We will have to fetch the answers from the Answer table based on response_id because in our case, the response is from a previous reviewee and not a reviewer. So, we will fetch those answers whose response type is FeedbackResponseMap and calculate scores for those questions for the corresponding ReviewScores table. Below are excerpts from the [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza database documentation] which describe the database tables relevant to our design.

=== Questions Table Structure ===


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

=== Answer Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

=== Response Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

=== Response Map Table ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

== Files that will be changed ==

1. To calculate average author feedback score: https://github.com/jainmohit1/expertiza/blob/master/app/models/on_the_fly_calc.rb

2. To populate average author feedback score for the view: the https://github.com/jainmohit1/expertiza/blob/master/app/controllers/review_mapping_controller.rb

3. To add a field in the view: https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/response_report.html.haml

4. To add a field in the partial : https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/_review_report.html.erb

5. To add a field in the partial: https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/_team_score.html.erb

= Test Plan =
We plan to test the response report page (/review_mapping/response_report?id={:assignmentID}) to make sure the new field (average author feedback) exists.

Using [http://rspec.info/ RSpec] we will add a test case to review_mapping_controller_spec.rb.

<pre>
context 'when type is FeedbackResponseMap' do
context 'when assignment has author feedback feature' do
it 'renders response_report page with average author feedback data' do
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)
allow(FeedbackResponseMap).to receive(:feedback_response_report).with('1', 'FeedbackResponseMap')
.and_return([participant, participant1], [1, 2], [3, 4], [])
params = {
id: 1,
report: {type: 'FeedbackResponseMap'},
}
get :response_report, params
expect(response).to render_template(:response_report)
expect(response).to have(:avg_author_feedback)
end
end
end
</pre>

We also plan to manually test the response report page to make sure the new field is aligning well in the UI in the expected place. We will attach the screenshot of the UI as the test result. We will test the cases of one and multiple reviews by a reviewer and verify the number and average scores of the metareviews for those reviews are rendered correctly.

= References =
1. http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

2. https://github.com/jainmohit1/expertiza

3. https://github.com/expertiza/expertiza/pull/1290

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2018-11-13T22:36:48Z

Mjain6: /* Controller-level Logic */

='''Problem Statement'''=
A key component of Expertiza is peer reviews, which provide feedback to authors so that they can improve their work. Expertiza also supports grading of these reviews to ensure students write quality reviews, helping them learn more about the assignment by looking at their peers' work. In addition, Expertiza allows for metareviews, which are reviews the authors of the original work write for the reviews of their original work. This author feedback is useful for grading the reviews because it indicates how helpful this review was to the authors of the original work. The objective of this project is to add metareview or author feedback information to the review report page, which shows a summary of all the reviews written by the students for an assignment.

='''Goal'''=

The aim of this project is to build this into the system. We need an additional column in the 'Review Report' page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

='''Design'''=

== User Interface Enhancements ==

In the page "Review report for Design exercise" (Log in as an instructor then go to Manage -> Assignments -> View review report.), we are planning to add one more column to show the average ratings for the author feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column. Below is the page we are planning to edit.

[[File:Feedback_new.png]]

== Controller-level Logic ==

The following method shows the code logic we are planning to write for calculating the average scores for the feedback given by authors for the reviews of their work.

<pre style="color: black; border:1px;">
def calculate_avg_score_by_feedback(question_answers, q_max_score)
# get score and summary of answers for each question
# only include divide the valid_answer_sum with the number of valid answers

valid_answer_counter = 0
question_score = 0.0
question_answers.each do |ans|
# calculate score per question
unless ans.answer.nil?
question_score += ans.answer
valid_answer_counter += 1
end
end

if valid_answer_counter > 0 and q_max_score > 0
# convert the score in percentage
question_score /= (valid_answer_counter * q_max_score)
question_score = question_score.round(2) * 100
end

question_score
end

</pre>

== Relevant Database Tables ==

The following are the table structures we will need for this feature. First, the questions table has all the questions based on the questionnaire. We will be only concerned with the questions in the feedback questionnaire. The answers for each question in the feedback questionnaire are saved in the Answers table below based on the Question ID. Now, in order to know if the answer is a feedback by team members or a review by reviewer, the mapping for the Answers table is done by the response_id which is a foreign key to the Response table. This Response table gives us the map_id which maps to a response map table. Now, the response map table gives us information on the reviewer_id, reviewee_id, reviewed_object_id (which is the ID for the assignment being reviewed) and the type (whether it's a teammate review, author feedback, a regular review, etc.). We will have to fetch the answers from the Answer table based on response_id because in our case, the response is from a previous reviewee and not a reviewer. So, we will fetch those answers whose response type is FeedbackResponseMap and calculate scores for those questions for the corresponding ReviewScores table. Below are excerpts from the [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza database documentation] which describe the database tables relevant to our design.

=== Questions Table Structure ===


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

=== Answer Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

=== Response Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

=== Response Map Table ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

== Files that will be changed ==

1. https://github.com/jainmohit1/expertiza/blob/master/app/models/on_the_fly_calc.rb

2. https://github.com/jainmohit1/expertiza/blob/master/app/controllers/review_mapping_controller.rb

3. https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/response_report.html.haml

4. https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/_review_report.html.erb

5. https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/_team_score.html.erb

= Test Plan =
We plan to test the response report page (/review_mapping/response_report?id={:assignmentID}) to make sure the new field (average author feedback) exists.

Using [http://rspec.info/ RSpec] we will add a test case to review_mapping_controller_spec.rb.

<pre>
context 'when type is FeedbackResponseMap' do
context 'when assignment has author feedback feature' do
it 'renders response_report page with average author feedback data' do
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)
allow(FeedbackResponseMap).to receive(:feedback_response_report).with('1', 'FeedbackResponseMap')
.and_return([participant, participant1], [1, 2], [3, 4], [])
params = {
id: 1,
report: {type: 'FeedbackResponseMap'},
}
get :response_report, params
expect(response).to render_template(:response_report)
expect(response).to have(:avg_author_feedback)
end
end
end
</pre>

We also plan to manually test the response report page to make sure the new field is aligning well in the UI in the expected place. We will attach the screenshot of the UI as the test result. We will test the cases of one and multiple reviews by a reviewer and verify the number and average scores of the metareviews for those reviews are rendered correctly.

= References =
1. http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

2. https://github.com/jainmohit1/expertiza

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2018-11-13T21:06:44Z

Mjain6: /* Code Logic */

='''Problem Statement'''=
In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide a feedback for this review in terms of ‘Author feedback’. While grading peer reviews, it would be nice for the instructors to take into account the author feedbacks given on a particular peer review, this will be helpful in evaluating how helpful the peer review actually was to the author of the project.

='''Goal'''=

The aim of this project is to build this into the system. We need an additional column in the 'Review Report' page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

='''Design'''=

== Database ==

The following are the table structures we will need for mapping. First, the questions table has all the questions based on the questionnaire. We will be only concerned with the questions in the feedback questionnaire. The answers for each question in the feedback questionnaire is saved in Answers table below based on Question ID. Now, in order to know if the answers is a feedback by team members or a review by reviewer, the mapping for Answers table is done by response_id which is a foreign key to response table. Response table gives us map_id which maps to Response Maps table. Now, Response Map table gives us information of the reviewer_id, reviewee_id, reviewed_object_id (which is the id for the assignment being reviewed) and the type (whether it's a teammate review, author feedback or a regular review). We will have to fetch the answers from the Answer table based on response_id because in our case, the response is from a reviewee and not a reviewer. So, we will fetch those answers whose response type is FeedbackResponseMap and calculate scores for those questions from Review_Scores table.

=== Questions Table Structure===


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

=== Answer Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

=== Response Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

=== Response Map Table ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

== UI Implementation ==

In the page Review report for Design exercise ( login as an instructor -> Manage -> Assignments -> View review report ), we are planning to add one more column to show the average ratings for the authors feedback on a particular assignment. The logic for calculating the average score for the feedback would be similar to already implemented logic for score awarded/ average score column. Below attached shows the page we are planning to edit.

[[File:Feedback_new.png]]

== Code Logic ==

Following shows the code logic we are planning to write for calculating the avg scores for the feedback given by authors.
<pre style="color: black; border:1px;">
def calculate_avg_score_by_criterion(question_answers, q_max_score)
# get score and summary of answers for each question
# only include divide the valid_answer_sum with the number of valid answers

valid_answer_counter = 0
question_score = 0.0
question_answers.each do |ans|
# calculate score per question
unless ans.answer.nil?
question_score += ans.answer
valid_answer_counter += 1
end
end

if valid_answer_counter > 0 and q_max_score > 0
# convert the score in percentage
question_score /= (valid_answer_counter * q_max_score)
question_score = question_score.round(2) * 100
end

question_score
end

</pre>

= Test Plan =
* Plan to test the response report page (/review_mapping/response_report?id={:assignmentID}) to make sure the new field (avg author feedback) exists
** Using rspec we will add a test case to ReviewMappingControllerSpec.rb
<pre>

context 'when type is FeedbackResponseMap' do
context 'when assignment has author feedback feature' do
it 'renders response_report page with average author feedback data' do
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)
allow(FeedbackResponseMap).to receive(:feedback_response_report).with('1', 'FeedbackResponseMap')
.and_return([participant, participant1], [1, 2], [3, 4], [])
params = {
id: 1,
report: {type: 'FeedbackResponseMap'},
}
get :response_report, params
expect(response).to render_template(:response_report)
expect(response).to have(:avg_author_feedback)
end
end
end
</pre>

* Also, we plan to test the response report page to make sure the new field is alighning well in the UI in the expected place

= References =
1) http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2018-11-13T19:34:38Z

Mjain6: /* UI Implementation */

= Problem Statement =

In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide a feedback for this review in terms of ‘Author feedback’. While grading peer reviews, it would be nice for the instructors to take into account the author feedbacks given on a particular peer review, this will be helpful in evaluating how helpful the peer review actually was to the author of the project.

= Goal =

The aim of this project is to build this into the system. We need an additional column in the 'Review Report' page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

= Design =

The following are the table structures we will need for mapping. First, the questions table has all the questions based on the questionnaire. We will be only concerned with the questions in the feedback questionnaire. The answers for each question in the feedback questionnaire is saved in Answers table below based on Question ID. Now, in order to know if the answers is a feedback by team members or a review by reviewer, the mapping for Answers table is done by response_id which is a foreign key to response table. Response table gives us map_id which maps to Response Maps table. Now, Response Map table gives us information of the reviewer_id, reviewee_id, reviewed_object_id (which is the id for the assignment being reviewed) and the type (whether it's a teammate review, author feedback or a regular review). We will have to fetch the answers from the Answer table based on response_id because in our case, the response is from a reviewee and not a reviewer. So, we will fetch those answers whose response type is FeedbackResponseMap and calculate scores for those questions from Review_Scores table.

== Questions Table Structure==


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

== Answer Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

== Response Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

== Response Map Table ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

== UI Implementation ==

In the page Review report for Design exercise ( login as an instructor -> Manage -> Assignments -> View review report ), we are planning to add one more column to show the average ratings for the authors feedback on a particular assignment. The logic for calculating the average score for the feedback would be similar to already implemented logic for score awarded/ average score column. Below attached shows the page we are planning to edit.

[[File:Feedback_new.png]]

= Test Plan =
= References =
1) http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2018-11-13T19:27:00Z

Mjain6: /* Response Map Table */

= Problem Statement =

In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide a feedback for this review in terms of ‘Author feedback’. While grading peer reviews, it would be nice for the instructors to take into account the author feedbacks given on a particular peer review, this will be helpful in evaluating how helpful the peer review actually was to the author of the project.

= Goal =

The aim of this project is to build this into the system. We need an additional column in the 'Review Report' page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

= Design =

The following are the table structures we will need for mapping. First, the questions table has all the questions based on the questionnaire. We will be only concerned with the questions in the feedback questionnaire. The answers for each question in the feedback questionnaire is saved in Answers table below based on Question ID. Now, in order to know if the answers is a feedback by team members or a review by reviewer, the mapping for Answers table is done by response_id which is a foreign key to response table. Response table gives us map_id which maps to Response Maps table. Now, Response Map table gives us information of the reviewer_id, reviewee_id, reviewed_object_id (which is the id for the assignment being reviewed) and the type (whether it's a teammate review, author feedback or a regular review). We will have to fetch the answers from the Answer table based on response_id because in our case, the response is from a reviewee and not a reviewer. So, we will fetch those answers whose response type is FeedbackResponseMap and calculate scores for those questions from Review_Scores table.

== Questions Table Structure==


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

== Answer Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

== Response Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

== Response Map Table ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

== UI Implementation ==
[[File:Feedback_new.png]]

= Test Plan =
= References =
1) http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2018-11-13T19:26:14Z

Mjain6: /* Response Map Table */

= Problem Statement =

In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide a feedback for this review in terms of ‘Author feedback’. While grading peer reviews, it would be nice for the instructors to take into account the author feedbacks given on a particular peer review, this will be helpful in evaluating how helpful the peer review actually was to the author of the project.

= Goal =

The aim of this project is to build this into the system. We need an additional column in the 'Review Report' page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

= Design =

The following are the table structures we will need for mapping. First, the questions table has all the questions based on the questionnaire. We will be only concerned with the questions in the feedback questionnaire. The answers for each question in the feedback questionnaire is saved in Answers table below based on Question ID. Now, in order to know if the answers is a feedback by team members or a review by reviewer, the mapping for Answers table is done by response_id which is a foreign key to response table. Response table gives us map_id which maps to Response Maps table. Now, Response Map table gives us information of the reviewer_id, reviewee_id, reviewed_object_id (which is the id for the assignment being reviewed) and the type (whether it's a teammate review, author feedback or a regular review). We will have to fetch the answers from the Answer table based on response_id because in our case, the response is from a reviewee and not a reviewer. So, we will fetch those answers whose response type is FeedbackResponseMap and calculate scores for those questions from Review_Scores table.

== Questions Table Structure==


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

== Answer Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

== Response Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

== Response Map Table ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

'''Sorting in ascending order''':-
[[File:Feedback_new.png]]

= Test Plan =
= References =
1) http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

File:Feedback new.png

2018-11-13T19:16:56Z

Mjain6: UI where we are planning to add a new column for the average ratings received from the authors.

UI where we are planning to add a new column for the average ratings received from the authors.

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2018-11-13T19:09:16Z

Mjain6: /* References */

= Problem Statement =

In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide a feedback for this review in terms of ‘Author feedback’. While grading peer reviews, it would be nice for the instructors to take into account the author feedbacks given on a particular peer review, this will be helpful in evaluating how helpful the peer review actually was to the author of the project. The aim of this project is to build this into the system. We need an additional column in the summary page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

= Design =

The following are the table structures we will need for mapping. First, the questions table has all the questions based on the questionnaire.
== Questions Table Structure==


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

== Answer Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

== Response Table Structure ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

== Response Map Table ==

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

= Test Plan =
= References =
1) http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

E1827 Topic management

2018-11-10T03:01:08Z

Mjain6: /* Functional Testing */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>

<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">


<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table></pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
# Method to save/update feedback given by the instructor in the suggestions table in feedback column
# After saving the data we redirect the user to the same page
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

== Testing Plan ==
=== UI Testing ===

===== Issue #971: Change create topic UI into AJAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.
===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Functional Testing ===

===== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions =====
# Login as an instructor.
# Click Manage -> Assignments.
# After clicking on the Assignment tab, a page will show all the assignments.
# Click the view suggestions icon on the right bottom corner.
# You will be able to see a list of suggestions given by the students for that particular topic.
# Add feedback in the feedback text box and click save feedback button to save it.
# To verify if the feedback was saved to the table, query suggestions table and match the feedback in the feedback column to the feedback given.

E1827 Topic management

2018-11-10T03:00:44Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.JAX */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>

<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">


<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table></pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
# Method to save/update feedback given by the instructor in the suggestions table in feedback column
# After saving the data we redirect the user to the same page
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

== Testing Plan ==
=== UI Testing ===

===== Issue #971: Change create topic UI into AJAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.
===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Functional Testing ===

===== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.JAX =====
# Login as an instructor.
# Click Manage -> Assignments.
# After clicking on the Assignment tab, a page will show all the assignments.
# Click the view suggestions icon on the right bottom corner.
# You will be able to see a list of suggestions given by the students for that particular topic.
# Add feedback in the feedback text box and click save feedback button to save it.
# To verify if the feedback was saved to the table, query suggestions table and match the feedback in the feedback column to the feedback given.

E1827 Topic management

2018-11-10T02:59:48Z

Mjain6: /* Functional Testing */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>

<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">


<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table></pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
# Method to save/update feedback given by the instructor in the suggestions table in feedback column
# After saving the data we redirect the user to the same page
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

== Testing Plan ==
=== UI Testing ===

===== Issue #971: Change create topic UI into AJAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.
===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Functional Testing ===

===== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.JAX =====
# Login as an instructor.
# Click Manage -> Assignments.
# After clicking on the Assignment tab, a page will show all the assignments.
# Click the view suggestions icon on the right bottom corner.
# You will be able to see a list of suggestions given by the students for that particular topic.
# Add feedback in the feedback text box and click save feedback button to save it.
# To verify if the feedback was saved to the table, query suggestions table.

E1827 Topic management

2018-11-10T02:48:05Z

Mjain6: /* Functional Testing */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>

<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">


<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table></pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
# Method to save/update feedback given by the instructor in the suggestions table in feedback column
# After saving the data we redirect the user to the same page
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

== Testing Plan ==
=== UI Testing ===

===== Issue #971: Change create topic UI into AJAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.
===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Functional Testing ===

===== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.JAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.

E1827 Topic management

2018-11-10T02:47:21Z

Mjain6: /* Testing Plan */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>

<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">


<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table></pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
# Method to save/update feedback given by the instructor in the suggestions table in feedback column
# After saving the data we redirect the user to the same page
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

== Testing Plan ==
=== UI Testing ===

===== Issue #971: Change create topic UI into AJAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.
===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Functional Testing ===

===== Issue #971: Change create topic UI into AJAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.

E1827 Topic management

2018-11-10T02:46:32Z

Mjain6: /* Testing Plan */

E1827 Topic management

2018-11-09T06:36:23Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

E1827 Topic management

2018-11-09T06:27:05Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
# Method to save/update feedback given by the instructor in the suggestions table in feedback column
# After saving the data we redirect the user to the same page
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

== Testing Plan ==
=== UI Testing ===

===== Issue #971: Change create topic UI into AJAX =====
# Login as an instructor.
# Click Assignments tab next to Courses
# Select the assignment for which a new topic has to be added
# Click the edit icon for the assignment and go to Topics tab
# You will be able to see the topics list in a table format. Click on add icon on the right side corner of the table header
# Fill in the details and click save topic

If a user tries to set number of slots as zero, a warning pops up and prohibits the user from doing so.
===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

E1827 Topic management

2018-11-03T02:58:42Z

Mjain6: /* Suggestions list page before changes */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

File:BeforeFeedbackPage.png

2018-11-03T02:58:04Z

Mjain6: New page for before page

New page for before page

E1827 Topic management

2018-11-03T02:56:11Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPageNew.png]]

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

E1827 Topic management

2018-11-03T02:55:03Z

Mjain6: /* Suggestions list page before changes */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page after changes =====

[[File:AfterFeedbackPage.png]]

E1827 Topic management

2018-11-03T02:54:51Z

Mjain6: /* Suggestions list page before changes */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:AfterFeedbackPage.png]]

E1827 Topic management

2018-11-03T02:54:39Z

Mjain6: /* Suggestions list page before changes */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:AfterFeedbackPage.png|200px|thumb|left]]

E1827 Topic management

2018-11-03T02:51:00Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:AfterFeedbackPage.png]]

E1827 Topic management

2018-11-03T02:50:10Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

===== Suggestions list page before changes =====

[[File:BeforeFeedbackPage.png]]

E1827 Topic management

2018-11-03T02:40:50Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

On the file '''expertiza/db/schema.rb''' ,schema changes as effect of adding column in table suggestions.

<pre style="color: black; border:1px;">
create_table "suggestions", force: :cascade do |t|
t.integer "assignment_id", limit: 4
t.string "title", limit: 255
t.text "description", limit: 65535
t.string "status", limit: 255
t.string "unityID", limit: 255
t.string "signup_preference", limit: 255
t.string "feedback", limit: 255
end
</pre>

E1827 Topic management

2018-11-03T02:33:34Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

On the file '''db/migrate/20181027001119_add_feedback_to_suggestion.rb''' ,added migration scripts. Script is adding a column name "feedback" in the suggestions table.

<pre style="color: black; border:1px;">
class AddFeedbackToSuggestion < ActiveRecord::Migration
def change
add_column :suggestions, :feedback, :string
end
end
</pre>

E1827 Topic management

2018-11-03T02:30:47Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''',added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

On the file '''app/controllers/suggestion_controller.rb''' ,added an additional method to save the changes in the feedback text box to database.

<pre style="color: black; border:1px;">
def update_feedback
Suggestion.find(params[:suggestion_id]).update_attributes(feedback: params[:suggestion][:feedback])
redirect_to list_suggestion_index_path(:id => params[:id], :type => params[:type])
end
</pre>

E1827 Topic management

2018-11-03T02:14:09Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''' we added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre style="color: black; border:1px;">
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

E1827 Topic management

2018-11-03T02:13:29Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

This wiki page describes the changes made according to the specification of E1827 OSS assignment for Fall 2018.
----
== Peer Review Information ==
The following credentials are recommended for testing the changes:

* Instructor Login: username: instructor6 password: password
* Youtube link: https://www.youtube.com/watch?v=_0UU0r4IOf4&feature=youtu.be

== Introduction ==
=== Background ===
Expertiza is a web portal which can be used to manage assignments related to a course. It provides a platform to view assignments, manage teams, select topics and work on improvement through anonymous peer reviews.

=== Problem Statement ===
Expertiza allows the instructor to define different topics that students or teams could choose from as their assignment. Each topic can have 0 or more slots that indicate the number of students or teams that can sign up for that topic. We identified several ideas that can improve user experience when managing the topics. Thus, we would like you to introduce new features to implement these ideas.

===== What needs to be done?: =====

* Issue #971 Change create topic UI into AJAX.

* Issue #926 We need a way to sort topics by topic number in assignment#edit page.

* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions.

== Files modified ==
The following files were modified
* app/views/sign_up_sheet/_add_signup_topics.html.erb
* app/views/sign_up_sheet/_table_header.html.erb
* app/views/sign_up_sheet/_table_line.html.erb
* app/controllers/sign_up_sheet_controller.rb
* app/views/assignments/edit.html.erb
* app/controllers/assignments_controller.rb
* app/views/suggestion/list.html.erb
* app/controllers/suggestion_controller.rb
* db/schema.rb

== Files Added ==
The following files were added
* db/migrate/20181027001119_add_feedback_to_suggestion.rb

== Solutions Implemented ==
=== Issue #971 Change create topic UI into AJAX ===
Currently, when instructors manually enter topics, they have to go back and forth between the list of the topic page (views>sign_up_sheet>_add_signup_topics.html.erb) and the create topic page (views>sign_up_sheet>new.html.erb). This should be done via AJAX so that the adding a new topic can be done through an editable grid or a popup form without leaving the list of topic page. Then and the list should be automatically updated when a new topic is entered.

In addition, when adding a topic, the default slot should be 1 instead of 0. the current warning message that shows up when the slot is 0, can't be closed properly and should be fixed (if the form is made popup in the future, the warning should be on the same page as the form e.g., highlight the field and print an instruction to change the # of slot).

On the file '''app/views/assignments/edit.html.erb''' we added an additional editable <tr> table element which is appended to the table when the add button is clicked in the topics table.
It submits a ajax request when the 'save topic button is clicked'
<pre style="color: black; border:1px;">
<div>
<table class="table table-striped">

<tr id="add_topic" style="display:none;">
<%= form_for :topic, :url => sign_up_sheet_index_path(:id => @assignment_form.assignment.id),:html => { :onsubmit => "return showZeroSlotWarning()",autocomplete: "off" } do |f| %>
<td><%= f.text_field :topic_identifier %></td>
<td><%= f.text_field :topic_name %></td>
<td><%= f.number_field :max_choosers, min: 0 %></td>
<td></td>
<td></td>
<td></td>
<td><%= f.submit %></td>
<% end %>
</tr>

</table>
</div>
<script>
function showZeroSlotWarning(){
if ($('#topic_max_choosers').val() == 0){
alert("If you create a topic with 0 slots, students cannot assign this topic.");
return false;
}
};
function addCreateTopicSection(){
$("#topic_table_header").after($("#add_topic"));
$("#add_topic").toggle();
};
</script>

</pre>

On the file '''app/views/assignments/_table_header.html.erb''' we added an additional editable <th> table element which adds a add topic button which toggles the editable row for creating topics.
<pre style="color: black; border:1px;">
<th width="3%" align="center"><a id="myLink" title="Add"
href="#" style="color: #00aa00; font-size: 26px;" onclick="addCreateTopicSection();return false;">+</a></th>
</pre>

On the file '''app/views/assignments/_add_signup_topics.html.erb''' we initialize the new topic with max_choosers as 1.
<pre style="color: black; border:1px;">
<% @sign_up_topic = SignUpTopic.new %>
<% @topic = @sign_up_topic %>
<% @topic.max_choosers=1 %>
</pre>

===== Topics table before changes =====

[[File:topic_3.png]]

===== Topics table after changes =====

[[File:topic_4.png]]

===== Warning message when max_choosers is set to zero =====

[[File:topic_5.png]]

=== Issue #926 We need a way to sort topics by topic number in assignment#edit page. ===
The task is to sort the Topics according to the topic number. This functionality is added using Tablesorter css, where clicking the topic# will toggle the topics in the ascending/descending order.

To use Tablesorter in app/views/sign_up_sheet/_add_signup_topics.html.erb, we added this script:-
<pre>
<script>
$(function () {
/*Function for sorting the table */
$(".sortable").tablesorter({
sortList: [[0,0]] //sort First Column by default when page loads
});
});
</script>
</pre>

And made this change to the current table in html:-
<pre>
<table class="table table-striped sortable">
<thead>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
<tr><%= render :partial => '/sign_up_sheet/table_header' %></tr>
</thead>
</pre>

Then to make Topic to be sortable, we added this in app/views/sign_up_sheet/_table_header.html.erb:-
<pre>
<th class="sorter-true" width="5%">Topic #</th>
</pre>

'''Sorting in ascending order''':-
[[File:Edit_ascending.png]]

'''Sorting in descending order''':-
[[File:Edit_descending.png]]

=== Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. ===
We should allow instructors to give feedback when accepting or rejecting topic suggestions. As it is, one can give feedback on topics suggested by students only when the instructor wants the topic to be revised, not when (s)he is approving or rejecting it. Feedback should be possible in any of these cases.

On the file '''app/views/suggestion/list.html.erb''' we added an additional editable textbox and a submit button. On click of the button the feedback provided in the text box is saved to the database in a table name suggestions, column name feedback.

<pre>
<table class="general" cellpadding=5 width=100% border=1>
<tr>
<th>Title</th>
<th>Status</th>
<th>Submitter's user name</th>
<th>Action</th>
<th>Feedback</th>
<th>Save</th>
</tr>

<% for suggestion in @suggestions %>
<tr class="listingRow">
<%= form_for :suggestion, :url => update_feedback_suggestion_index_path(:suggestion_id => suggestion.id, :id => params[:id], :type => params[:type]) do |f| %>
<td style="max-width: 200px"><%=h suggestion.title %></td>
<td align="center"><%=h suggestion.status %></td>
<td align="center"><%=h suggestion.unityID %></td>
<td align="center"><%= link_to 'View', :action => 'show', :id => suggestion %></td>
<td align="center"><%= f.text_field :feedback %></td>
<td align="center"><%= f.submit 'Save Feedback' %></td>
<% end %>
</tr>
<% end %>
</table>
</pre>

E1827 Topic management

2018-11-03T02:11:00Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

E1827 Topic management

2018-11-03T02:07:14Z

Mjain6: /* Issue #718 We should allow instructors to give feedback when accepting or rejecting topic suggestions. */

File:AfterFeedbackPage.png

2018-11-03T02:04:22Z

Mjain6:

File:Before Feedback page.png

2018-11-03T02:00:57Z

Mjain6: uploaded a new version of "File:Before Feedback page.png"

File:Before Feedback page.png

2018-11-03T01:59:28Z

Mjain6:

E1827 Topic management

2018-11-03T01:56:48Z

Mjain6: /* Files Added */

E1827 Topic management

2018-11-03T00:18:25Z

Mjain6: /* Files Added */

E1827 Topic management

2018-11-03T00:17:46Z

Mjain6: /* Files modified */

E1827 Topic management

2018-11-03T00:17:07Z

Mjain6: /* Files modified */

E1827 Topic management

2018-11-03T00:13:14Z

Mjain6: /* Peer Review Information */