Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1975. Generalize Review Versioning

2019-11-12T04:50:15Z

Psdravid: /* Rspec */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Introduction''' ==
Expertiza is a peer-review based learning platform in which work-products by students are evaluated and scored by peer-review of other students. Review process occurs in stages. After submission of initial feedback for a work-product by the peer-group, students are allowed time to incorporate the comments and improve their work. This second version of the work product is reviewed again and scores are given. This process might be repeated again and the average score from the last review stage is considered as the final score for that work-product. This incremental development of work-products and progressive learning is the fundamental concept underlying the Expertiza system.

=====Purpose=====
The system currently is designed to give a reviewer a new form for each round of review (rather than requiring the reviewer to edit an existing file) and automatically remove scores of reviews that are not redone. The system also triggers an email to reviewer when there is a change in the submission. The scores are calculated on the fly based on the rubrics.

=====Scope=====
This project will enhance the existing scoring and peer review functionality and the underlying implementation along with the testing of the existing implementation. Testing of the score calculation, display for the weighted and non-weighted scores based on the combination of the rubrics are part of this project. This project also includes an additional feature for the author to notify the reviewers for the change in the submission.

=====Background=====
The system currently is designed to give a reviewer a new form for each round of review (rather than requiring the reviewer to edit an existing file) and automatically remove scores of reviews that are not redone. The scores are calculated based on the rubrics defined in the system. There’s already an existing implementation for the computation of score but it doesn’t work for multipart rubric

=====Documentation=====
The documents that will be generated for this project are the design document, the actual files that we edit or create, and a ReadMe that explains what we did and how to use the modified product.

=====Standards=====
The new standards that will be adhered to in this system are those given for the rails framework, and the code should follow rails and object oriented design principles. Any newly added code will adhere to the guidelines mentioned below:

● https://github.com/rubocop-hq/rails-style-guide 
● http://wiki.expertiza.ncsu.edu/index.php/Object-Oriented_Design_and_Programming.

== '''Problem Statement''' ==
=====Problem=====
The system currently is designed to give a reviewer a new form for each round of review (rather than requiring the reviewer to edit an existing file) and automatically remove scores of reviews that are not redone. The functionality needs to be tested. It works in some cases, but we are suspicious that it is not entirely correct.

'''Profile Email Preference''':
User in expertiza has liberty to control what kind of emails they should receive. As the reviewers will receive an email for the change in submission. This can be controlled by selecting an option (When someone else submits work I am assigned to review) on the profile page of the user. As the checkboxes are far away on the right corner of the screen, the position of checkboxes need to be changed to make it more user friendly.
 

Scores for students in Expertiza can be based on a combination of rubrics: review rubrics for each round of review, author feedback, and teammate review. In CSC/ECE 517, we don’t really use the student-assigned scores to grade projects, but the peer-review score shown to the student is based entirely on the second round of review 

Here is how scores are calculated: 

1. If only zero-weighted scores are available (here, in the first round of review), the average of all zero-weighted scores should be shown in grey font. An information button should explain why the scores are shown in grey (“The reviews submitted so far do not count toward the author’s final grade.”): 

2. If any non-zero weighted scores are available, then the score shown for the assignment should be the weighted average of the scores. For example, if Round 2 reviews are weighted 90% and author feedback is weighted 10%, and two Round 2 reviews each gave the work a score of 80%, and the only author-feedback score was 100%, then the overall score is:: 
80%⨉90% + 100%⨉10% = 82%

3. If a review is submitted, and then the author(s) update the submission before the end of the current round, it will reopen the review, and then the reviewer can go in and update the submitted review. '''However, the previous review score that was given in the current round will count until the reviewer updates the submitted review'''. '''This functionality doesn’t work for multipart rubrics.''' 

The system also doesn’t generate emails to reviewers in case a new submission is made by the author without changing submission parameters like submission URL. Eg: A new submission is made by making a new deployment. But the deployment URL doesn’t change. In this case as well, without changing the current flow the author should have an option to notify all the reviewers to revisit the submission.

=====Interface Requirement=====
The overall user interface would remain the same as of the current system. Since this is a modification to the current submission page, there will be a new addition to the submission page. On the submission page, there will be a new button to notify reviewers when there is a submission which doesn’t contain a change to submission parameters like submission URL, but the deployment has been updated on the same URL. Other than that the interface remains the same for the score page, only functionalities will be tested for multi-part rubrics.

=====Quality Requirements=====
The interface changes are minimal and very easy to adapt. The new button will be clearly visible and is supposed to have a clear text to interpret its functionality. The proposed changes should not affect the current system functionality in any way. The solution is only intended to enrich the project features.

=====Portability Requirements=====
All of the changes for this enhancement to Expertiza should not interfere with the platform portability in any way.

=====Performance Requirements=====
Adding test for multi-part rubric functionality should not cause any overhead in the performance of the system. Sending emails through “Notify All Reviewers” button should affect the system minimally in terms of performance. The only overhead is a database query to get all the reviewers. A good database design should incorporate such a query smoothly.

=====Assumptions=====
The functionality should work in case the assignment rubric is not multi-part.

== '''Proposed Solution''' ==
=====Zero-weighted scores=====
If only zero-weighted scores are available in the first round of review, the average of all zero-weighted scores will be shown in a gray font. An information button will explain why the scores are shown in gray (“The reviews submitted so far do not count toward the author’s final grade”)

Inside compute_total_score method in on_the_fly_calc.rb module, we'll check if the weighted score exists, if not then we'll calculate the non weighted score. We'll also have to add a method in the questionnaire model to get non weighted score. Few changes are required for the UI to display non-weighted score in grey with information icon and non weighted score in black.

Possible files to be modified.

models/on_the_fly_calc.rb 
models/questionnaire.rb 
models/view_team.html.erb

===== Non-zero weighted scores=====
If any non-zero weighted scores are available, then the score shown for the assignment should be the weighted average of the scores. For example, if Round 2 reviews are weighted 90% and author feedback is weighted 10%, and two Round 2 reviews each gave the work a score of 80%, and the only author-feedback score was 100%, then the overall score is 80%⨉90% + 100%⨉10% = 82%

We'll first write the test cases by adding test cases to the '''spec/models/on_the_fly_calc_spec.rb'''

Also, we'll test this manually by computing the score and if there's a bug then below are the possible files to be modified.

models/on_the_fly_calc.rb 
models/questionnarie.rb

=====Review Update=====
If a review is submitted, and then the author(s) update the submission before the end of the current round, it will reopen the review, and then the reviewer can go in and update the submitted review. However, the previous review score that was given in the current round will count until the reviewer updates the submitted review. This functionality already exists in the existing system. However, In some submissions, there’s no change in the submitted URL’s so there’s no way to let the reviewers know that the author has made some changes in the project. We’ll add a notify button for the Author in the UI which will trigger an email to the reviewers. This will reopen the review, and then the reviewer can go in and update the submitted review. However, the previous review score that was given in the current round will count until the reviewer updates the submitted review

'''Sending an email when the submission parameters don’t change:'''

A new button will be added on the submission page. The button will enable the author to notify all the reviewers to revisit the submission. The email will be sent to all the assigned reviewers only if their email preference (When someone else submits work I am assigned to review) in the profile is set to receive the email.

=====Profile Email Preference=====
The checkboxes are moved to the left corner. As the layout of the options have used table layout. So, we'll increase the width of the the column which includes checkboxes. We'll be using the percentage instead of fixed value to give the width, as this would adjust the column size based on the screen size. The CSS can be applied to the '''layout.scss''' file to using the appropriate class given to the column 

[[File:E1975_CHECKBOX_1.jpg]]

 
[[File:Use Case 1.png]]

=='''Test Plan'''==

=====Rspec=====

New test cases will be added to test and validate the functionalities which are not working as expected. Also the test cases for features that will be newly added to the system, will also be written. Test cases will be added to these files:
spec/models/on_the_fly_calc_spec.rb 
spec/models/questionnaire_spec.rb 

The scenarios covered by the newly introduced test cases are as follows: 
1. Zero weighted scores 
2. Non-zero weighted scores 
3. Review update 
4. Sending an email when the submission parameters don’t change 

=====Email Preferences UI Changes=====

The email preferences checkboxes at present appear sticking to the rightmost border of the page. By following the requirements the checkboxes will be made available closer to the text fields to make them look more user-friendly.
The changes can be tested by logging into the system and on the user profile page.

=====Manual Testing=====

'''Step 1'''. The instructor will create an assignment and assign the zero and non-zero weights to the rubrics. 
'''Step 2'''. The author submits the work done in expertiza. 
'''Step 3'''. Peers check the submitted work and give reviews for it. 

'''Test 1: Zero weighted scores shown in gray.''' 
Login as an author in expertiza and go to scores page to view the feedback.
Zero weighted scores should be displayed in gray to the logged in user.

'''Test 2: Information button.''' 
Login as an author in expertiza and go to scores page to view the feedback.
The information button should explain why the scores are shown in gray (“The reviews submitted so far do not count toward the author’s final grade.”)

'''Step 4'''. The mentor evaluates the final submission and give grades.

'''Test 3: Display non-zero weighted scores''' 
Login as an author in expertiza and go to scores page to view the feedback.
The scores shown for the assignment should be the weighted average of the scores.
The zero weighted scores have to be replaced with non-zero weighted scores.

'''Step 5''': The author updates the work and re-submits it again.

'''Test 4: Review Update''' 
The Review should be reopened. The reviewer should be able to go and update the submitted review.
If the review is not updated the previous review score has to be retained.

'''Test 5: Notify reviewers''' 
The notify button on submission page should send a notification to all the corresponding reviewers to revisit the submission and update the reviews.

CSC/ECE 517 Fall 2019 - E1975. Generalize Review Versioning

2019-11-12T04:47:06Z

Psdravid: /* Rspec */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Introduction''' ==
Expertiza is a peer-review based learning platform in which work-products by students are evaluated and scored by peer-review of other students. Review process occurs in stages. After submission of initial feedback for a work-product by the peer-group, students are allowed time to incorporate the comments and improve their work. This second version of the work product is reviewed again and scores are given. This process might be repeated again and the average score from the last review stage is considered as the final score for that work-product. This incremental development of work-products and progressive learning is the fundamental concept underlying the Expertiza system.

=====Purpose=====
The system currently is designed to give a reviewer a new form for each round of review (rather than requiring the reviewer to edit an existing file) and automatically remove scores of reviews that are not redone. The system also triggers an email to reviewer when there is a change in the submission. The scores are calculated on the fly based on the rubrics.

=====Scope=====
This project will enhance the existing scoring and peer review functionality and the underlying implementation along with the testing of the existing implementation. Testing of the score calculation, display for the weighted and non-weighted scores based on the combination of the rubrics are part of this project. This project also includes an additional feature for the author to notify the reviewers for the change in the submission.

=====Background=====
The system currently is designed to give a reviewer a new form for each round of review (rather than requiring the reviewer to edit an existing file) and automatically remove scores of reviews that are not redone. The scores are calculated based on the rubrics defined in the system. There’s already an existing implementation for the computation of score but it doesn’t work for multipart rubric

=====Documentation=====
The documents that will be generated for this project are the design document, the actual files that we edit or create, and a ReadMe that explains what we did and how to use the modified product.

=====Standards=====
The new standards that will be adhered to in this system are those given for the rails framework, and the code should follow rails and object oriented design principles. Any newly added code will adhere to the guidelines mentioned below:

● https://github.com/rubocop-hq/rails-style-guide 
● http://wiki.expertiza.ncsu.edu/index.php/Object-Oriented_Design_and_Programming.

== '''Problem Statement''' ==
=====Problem=====
The system currently is designed to give a reviewer a new form for each round of review (rather than requiring the reviewer to edit an existing file) and automatically remove scores of reviews that are not redone. The functionality needs to be tested. It works in some cases, but we are suspicious that it is not entirely correct.

'''Profile Email Preference''':
User in expertiza has liberty to control what kind of emails they should receive. As the reviewers will receive an email for the change in submission. This can be controlled by selecting an option (When someone else submits work I am assigned to review) on the profile page of the user. As the checkboxes are far away on the right corner of the screen, the position of checkboxes need to be changed to make it more user friendly.
 

Scores for students in Expertiza can be based on a combination of rubrics: review rubrics for each round of review, author feedback, and teammate review. In CSC/ECE 517, we don’t really use the student-assigned scores to grade projects, but the peer-review score shown to the student is based entirely on the second round of review 

Here is how scores are calculated: 

1. If only zero-weighted scores are available (here, in the first round of review), the average of all zero-weighted scores should be shown in grey font. An information button should explain why the scores are shown in grey (“The reviews submitted so far do not count toward the author’s final grade.”): 

2. If any non-zero weighted scores are available, then the score shown for the assignment should be the weighted average of the scores. For example, if Round 2 reviews are weighted 90% and author feedback is weighted 10%, and two Round 2 reviews each gave the work a score of 80%, and the only author-feedback score was 100%, then the overall score is:: 
80%⨉90% + 100%⨉10% = 82%

3. If a review is submitted, and then the author(s) update the submission before the end of the current round, it will reopen the review, and then the reviewer can go in and update the submitted review. '''However, the previous review score that was given in the current round will count until the reviewer updates the submitted review'''. '''This functionality doesn’t work for multipart rubrics.''' 

The system also doesn’t generate emails to reviewers in case a new submission is made by the author without changing submission parameters like submission URL. Eg: A new submission is made by making a new deployment. But the deployment URL doesn’t change. In this case as well, without changing the current flow the author should have an option to notify all the reviewers to revisit the submission.

=====Interface Requirement=====
The overall user interface would remain the same as of the current system. Since this is a modification to the current submission page, there will be a new addition to the submission page. On the submission page, there will be a new button to notify reviewers when there is a submission which doesn’t contain a change to submission parameters like submission URL, but the deployment has been updated on the same URL. Other than that the interface remains the same for the score page, only functionalities will be tested for multi-part rubrics.

=====Quality Requirements=====
The interface changes are minimal and very easy to adapt. The new button will be clearly visible and is supposed to have a clear text to interpret its functionality. The proposed changes should not affect the current system functionality in any way. The solution is only intended to enrich the project features.

=====Portability Requirements=====
All of the changes for this enhancement to Expertiza should not interfere with the platform portability in any way.

=====Performance Requirements=====
Adding test for multi-part rubric functionality should not cause any overhead in the performance of the system. Sending emails through “Notify All Reviewers” button should affect the system minimally in terms of performance. The only overhead is a database query to get all the reviewers. A good database design should incorporate such a query smoothly.

=====Assumptions=====
The functionality should work in case the assignment rubric is not multi-part.

== '''Proposed Solution''' ==
=====Zero-weighted scores=====
If only zero-weighted scores are available in the first round of review, the average of all zero-weighted scores will be shown in a gray font. An information button will explain why the scores are shown in gray (“The reviews submitted so far do not count toward the author’s final grade”)

Inside compute_total_score method in on_the_fly_calc.rb module, we'll check if the weighted score exists, if not then we'll calculate the non weighted score. We'll also have to add a method in the questionnaire model to get non weighted score. Few changes are required for the UI to display non-weighted score in grey with information icon and non weighted score in black.

Possible files to be modified.

models/on_the_fly_calc.rb 
models/questionnaire.rb 
models/view_team.html.erb

===== Non-zero weighted scores=====
If any non-zero weighted scores are available, then the score shown for the assignment should be the weighted average of the scores. For example, if Round 2 reviews are weighted 90% and author feedback is weighted 10%, and two Round 2 reviews each gave the work a score of 80%, and the only author-feedback score was 100%, then the overall score is 80%⨉90% + 100%⨉10% = 82%

We'll first write the test cases by adding test cases to the '''spec/models/on_the_fly_calc_spec.rb'''

Also, we'll test this manually by computing the score and if there's a bug then below are the possible files to be modified.

models/on_the_fly_calc.rb 
models/questionnarie.rb

=====Review Update=====
If a review is submitted, and then the author(s) update the submission before the end of the current round, it will reopen the review, and then the reviewer can go in and update the submitted review. However, the previous review score that was given in the current round will count until the reviewer updates the submitted review. This functionality already exists in the existing system. However, In some submissions, there’s no change in the submitted URL’s so there’s no way to let the reviewers know that the author has made some changes in the project. We’ll add a notify button for the Author in the UI which will trigger an email to the reviewers. This will reopen the review, and then the reviewer can go in and update the submitted review. However, the previous review score that was given in the current round will count until the reviewer updates the submitted review

'''Sending an email when the submission parameters don’t change:'''

A new button will be added on the submission page. The button will enable the author to notify all the reviewers to revisit the submission. The email will be sent to all the assigned reviewers only if their email preference (When someone else submits work I am assigned to review) in the profile is set to receive the email.

=====Profile Email Preference=====
The checkboxes are moved to the left corner. As the layout of the options have used table layout. So, we'll increase the width of the the column which includes checkboxes. We'll be using the percentage instead of fixed value to give the width, as this would adjust the column size based on the screen size. The CSS can be applied to the '''layout.scss''' file to using the appropriate class given to the column 

[[File:E1975_CHECKBOX_1.jpg]]

 
[[File:Use Case 1.png]]

=='''Test Plan'''==

=====Rspec=====

New test cases will be added to test and validate the functionalities which are not working as expected. Also the test cases for features that will be newly added to the system, will also be written. Test cases will be added to these files:
spec/models/on_the_fly_calc_spec.rb 
spec/models/questionnaire_spec.rb 

The scenarios covered by the newly introduced test cases are as follows:
1.

=====Email Preferences UI Changes=====

The email preferences checkboxes at present appear sticking to the rightmost border of the page. By following the requirements the checkboxes will be made available closer to the text fields to make them look more user-friendly.
The changes can be tested by logging into the system and on the user profile page.

=====Manual Testing=====

'''Step 1'''. The instructor will create an assignment and assign the zero and non-zero weights to the rubrics. 
'''Step 2'''. The author submits the work done in expertiza. 
'''Step 3'''. Peers check the submitted work and give reviews for it. 

'''Test 1: Zero weighted scores shown in gray.''' 
Login as an author in expertiza and go to scores page to view the feedback.
Zero weighted scores should be displayed in gray to the logged in user.

'''Test 2: Information button.''' 
Login as an author in expertiza and go to scores page to view the feedback.
The information button should explain why the scores are shown in gray (“The reviews submitted so far do not count toward the author’s final grade.”)

'''Step 4'''. The mentor evaluates the final submission and give grades.

'''Test 3: Display non-zero weighted scores''' 
Login as an author in expertiza and go to scores page to view the feedback.
The scores shown for the assignment should be the weighted average of the scores.
The zero weighted scores have to be replaced with non-zero weighted scores.

'''Step 5''': The author updates the work and re-submits it again.

'''Test 4: Review Update''' 
The Review should be reopened. The reviewer should be able to go and update the submitted review.
If the review is not updated the previous review score has to be retained.

'''Test 5: Notify reviewers''' 
The notify button on submission page should send a notification to all the corresponding reviewers to revisit the submission and update the reviews.

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:21:53Z

Psdravid: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams there are different options to handle conflicting team names as shown in the screenshot below. We’d like to add another option to rename EXISTING team when a conflict exist. Introduce an option to rename the existing team in import_file/start.html.erb, handle this option in import_file_controller.rb and team.rb→import.

'''Solution''': This was a request to add an option to rename existing team if there was a conflict in the team name.
New code introduced was as follows: 
In '''start.html.erb''' 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]] 
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:21:35Z

Psdravid: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:21:07Z

Psdravid: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the '''import_file_controller.rb#import_from_hash'''
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====
'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918 sample.png]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

File:918 sample.png

2019-11-06T23:20:36Z

Psdravid:

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:15:13Z

Psdravid: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In '''team.rb''' 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

::'''[Problem 3 (329)]'''
::::A new testcase was added to test this functionality. We use it to check if the older team gets the new name and the new team gets the requested name. This testcase runs when we run bundle exec for the '''teams_spec.rb'''
# New team name should remain the same, the old one gets updated
context 'when handle_dups option is rename_existing' do
it 'returns new team name' do
allow(Course).to receive(:find).with(1).and_return(double('Course', name: 'course 1'))
allow(Team).to receive(:generate_team_name).with('course 1').and_return('new name of team')
expect(Team.handle_duplicate(team, 'no name', 1, 'rename_existing', CourseTeam)).to eq('no name')
end
end
 
*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv) [[File:918_sample.csv]]
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:10:22Z

Psdravid: /* Issue 918 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim_non_ascii' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
...
elsif teamtype.is_a?(AssignmentTeam.class)
...

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:08:04Z

Psdravid: /* Issue 918 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Here, a new function 'trim' has been added which iterates a given string character by character, and replaces each non ascii character with a white space character. 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
The handling of handle_dups in options was done assuming that the parameter was a symbol. But when tested, it was found to be a string and hence the handling was updated accordingly.
 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
Also, the if and else conditions for checking class type of used was wrong. This was updated based on how the variable was assigned in the import_file_controller.rb#import_from_hash
Code:
if(teamtype.is_a?(CourseTeam.class))
elsif teamtype.is_a?(AssignmentTeam.class)

 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T23:04:53Z

Psdravid: /* Issue 918 */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

'''Problem:''' The application is not able to import topics with non ascii characters in its description field. 
'''Solution:''' Before the topic object is persisted into the database, check for any non ascii characters in the description field and strip them. 
'''Code Changes''' 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 

def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

'''Problem''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team.

'''Solution''': This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters.
 
Code was modified to ensure minimal impact to existing testcases and functionalities. 

Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 

=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

File:918 p2.png

2019-11-06T23:01:35Z

Psdravid: uploaded a new version of "File:918 p2.png"

File:918 p2.png

2019-11-06T23:01:32Z

Psdravid:

File:918 p1.png

2019-11-06T23:00:18Z

Psdravid: uploaded a new version of "File:918 p1.png"

File:918 p1.png

2019-11-06T22:58:08Z

Psdravid: uploaded a new version of "File:918 p1.png"

File:918 p1.png

2019-11-06T22:57:36Z

Psdravid:

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T22:57:24Z

Psdravid: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters. 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 
=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:918_p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:918_p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T22:56:53Z

Psdravid: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters. 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 
=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::[[File:p1.png]]
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::[[File:p2.png]]
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-11-06T22:55:15Z

Psdravid: /* Test Plan */

__TOC__

== '''About Expertiza''' ==

Expertiza is an open source project based on Ruby on Rails framework and the code is available on Github. Expertiza allows the instructor to create new assignments as well as edit new or existing assignments. Instructors can also create a list of topics the students can sign up for and specify deadlines for completion of various tasks. Students can form teams in Expertiza to work on various projects and assignments as well as peer review other students' submissions. Expertiza supports submission across various document types, including the URLs Wiki pages.
 
 

== '''Problem Statement''' ==
The import feature is the most helpful feature for instructors to set up assignments. The instructors usually have a list of students, teams, etc from their learning management system. Being able to import these into expertiza saves a lot of time when setting up an assignment. Unfortunately this feature has some bugs that were identified as the following list.

'''Issue 918''': It seems that non-ASCII characters in the description (e.g., a curly apostrophe, and perhaps also an en-dash) caused a SQL error in inserting the description string into the db. I had to edit the import file to remove non-ASCII characters. Any Unicode character ought to be allowed in a description.

'''Issue 153''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic. '''This issue is not a bug but an additional feature to the existing import topic functionality.'''

'''Issue 329''': When importing teams there are different options to handle conflicting team names

'''Issue 328''': When importing teams, and a conflict exists there is an option to merge the two teams by inserting the new members into an existing team. Unfortunately, this feature is broken. we tried to import a team and selected 'Insert any new members into existing team'. No new team members were in fact inserted into the team

== '''Fixes''' ==
=====Issue 918=====

New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

=====Issue 328=====

This was an issue to fix the functionality of Insert any new members into existing team. This was due to faulty handling of the option handle_dups and incorrect checking of parameters. 
Code was modified to ensure minimal impact to existing testcases and functionalities. 
Code:
name = handle_duplicate(team, name, id, options["handle_dups"], teamtype)
 
[[File:E1938_Before_D.PNG]]
 
After fixing changes 
[[File:Insert_new_in_old.PNG]]
 
 
=====Issue 329=====

This was a request to add an option to rename existing team if there was a conflict in the team name. 
New code introduced was as follows: 
In start.html.erb 
In this file, the new option as displayed to the user is added 
<option value="rename_existing">rename the existing team and import</option>
 

In team.rb 
In this file, the handling of the new tag "rename_existing" is added wherein, the old team is updated with a new name. 
# E1938: Added handling for renaming old team when conflict arises
if handle_dups == "rename_existing"
if teamtype.is_a?(CourseTeam.class)
team.update(name: self.generate_team_name(Course.find(id).name))
elsif teamtype.is_a?(AssignmentTeam.class)
team.update(name: self.generate_team_name(Assignment.find(id).name))
end
return name
end

 
The state of D before conflicting import: 
 
[[File:E1938_Before_D_1.PNG]]
 
After fixing changes 
[[File:After_D.PNG]]
[[File:After_old_team.PNG]] 
As you can see the new team got the name D and the old file got renamed to Team_17.
 
 

=====Issue 153=====
'''Requirement''': There should be a way to import a list of who has signed up for which topic. When a signup sheet is used in Expertiza, users are expected to sign up for topics. But, the instructor might've taken signups offline, e.g., by passing around a signup sheet in class. There should be a way to import this list to Expertiza, rather than impersonate all the students one by one and sign them up for a topic.

'''Solution''': We have modified the existing implementation for import topics to assign the teams to the topics. We have changed the files to handle another column where the teams have been assigned to topics. The column is optional because there might be topics that have not yet been assigned to any teams

'''Expectations from the import file:
'''
 
* Assigned team name should exist in the system, otherwise the import will fail. Instructor has to make sure that the teams which are assigned in the import file should exist with same names in the system or database.
* Instructor also need to ensure that the topic for which the team is being assigned should not be full or can accommodate new team assignment to the respective topic.
 
'''Code Changes:'''
 
 
'''import_file/_sign_up_topic.html.erb'''
 
As there's already a screen with select options to map the columns with the fields for import. We are just adding another column so the best way is to extend the existing select tag with a new option for the teams assigned. All the select tags has been changed with an additional option "Assigned Team".
 
<th>
<select name="select1" id="select1" class="form-control" style="background-color:lightgrey">
<option value="topic_identifier">Topic Identifier (required)</option>
<option value="topic_name">Topic Name (required)</option>
<option value="max_choosers">Max Choosers (required)</option>
<option value="category">Category (optional)</option>
<option value="description">Description (optional)</option>
<option value="link">Link (optional)</option>
<option value="assigned_team">Assigned Team (optional)</option>
</select>
</th>

 
'''model/sign_up_topic.rb'''
 
The existing import function in the model import the topics to the topic table. As per the requirement and validations, topic should be imported first and then only the team can be assigned to the topic. So the existing import method has been modified to assign the team once the topic is imported in the database table. As per the edge case mentioned in the requirement document that few topics may not have any team assigned to it, so we first check if topic has any team assigned, then only it tries to map the topic with the team.
 
def self.import(row_hash, session, _id = nil)
if row_hash.length < 3
raise ArgumentError, "The CSV File expects the format: Topic identifier, Topic name, Max choosers, Topic Category (optional), Topic Description (Optional), Topic Link (optional), Assigned Team Name (optional)."
end
topic = SignUpTopic.where(topic_name: row_hash[:topic_name], assignment_id: session[:assignment_id]).first
if topic.nil?
attributes = ImportTopicsHelper.define_attributes(row_hash)
topic_new_id = ImportTopicsHelper.create_new_sign_up_topic(attributes, session)
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
ImportTopicsHelper.assign_team_topic(topic_new_id, team.id)
end
else
topic.max_choosers = row_hash[:max_choosers]
topic.topic_identifier = row_hash[:topic_identifier]
topic.save
unless row_hash[:assigned_team].nil?
team = Team.where(name: row_hash[:assigned_team]).first
newteam = SignedUpTeam.where(topic_id: topic.id, team_id: team.id).first
if newteam.nil?
ImportTopicsHelper.assign_team_topic(topic.id, team.id)
else
newteam.team_id = team.id
newteam.save
end
end
end
end

'''helpers/import_topics_helper.rb'''
 
Having the assign_team_topic in the helper would organize the code but also in the unit testing. We can isolate the model logic and test this method separately by writing the test cases.
 
def self.assign_team_topic(topic_id, assigned_team)
attributes = {}
attributes["topic_id"] = topic_id
attributes["team_id"] = assigned_team
assign_team = SignedUpTeam.new(attributes)
assign_team.save!
end

def self.create_new_sign_up_topic(attributes, session)
sign_up_topic = SignUpTopic.new(attributes)
sign_up_topic.assignment_id = session[:assignment_id]
sign_up_topic.save
# sign_up_topic
sign_up_topic.save!
sign_up_topic.id
end

 
'''controllers/import_file_controller.rb'''
 
Existing implementation for import have many flaws and design issues. Most of the code has been written with nested if else, which is not the practice to be followed. Also the names of the fields have been hardcoded.
 
As we cannot change the complete import implementation. So i had to use the existing one the way it is and make changes to extend the functionality.
 

if (params[:assigned_team] == 'true')
@optional_count += 1
end
 
elsif params[:optional_count] == '4'
new_header = [params[:select1], params[:select2], params[:select3], params[:select4], params[:select5], params[:select6], params[:select7]]
@header_integrated_body = hash_rows_with_headers(new_header,contents_hash[:body])

 
'''views/sign_up_sheet/_add_topics.html.erb'''
 
This code has been used to display the columns in the footer.As we already have implementation for other columns, so another column name 'Assigned Team' is added here in this part of the code.
<%= link_to 'Import topics',
{
:controller => 'import_file',
:action => 'start',
:model => 'SignUpTopic',
:id => params[:id],
:expected_fields => 'Topic Identifier' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Name' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Max Choosers' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Category (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Description (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Topic Link (optional)' +
'&nbsp&nbsp|&nbsp&nbsp' +
'Assigned Team (optional)'

An option column checkbox (Teams Assigned) has been added to the UI
 
 
[[File:Issue153SS8.jpg]]
 
 
A new column Assigned Team is added where the columns are being mapped.
 
 
[[File: Issue153SS7.jpg]]

 
 

== '''Test Plan''' ==
*'''RSpec:'''

::We have added new testcases for the new pieces of code that were added by us.

*'''UI Testing:'''

::'''[Problem 1 (918)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Go to Assignments and click on edit for any of the listed assignments.
::::3. Click on Topics tab.
::::4. Scroll down to the bottom of the page and click on Import topics.
::::5. Click on Topic Description checkbox and import the following file. (sample.csv)
::::6. Click on next and make the header for 4th column as 'Description' from the dropdown.
::::7. Import topics.
::::8. After this, a new topic should be imported which can be viewed from the aforementioned Topics tab. This newly imported topic will not have any non-ascii characters.

::'''[Problem 3 (329)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "rename the existing team and import" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the new team got created with the assigned name and the older team's name got changed.

::'''[Problem 4 (328)]'''
::::1. Login to Expertiza using username: instructor6 & password: password.
::::2. Select Manage > Courses or Assignments > Add Teams button > Import Team
::::3. In the screen that loads, select "Insert any new members into existing team" in the handle conflicts section.
::::4. Upload a file with the team details and select the appropriate delimiter.
::::5. Click on Create
::::6. Verify that the existing team got updated with the new team members

::::[[File:DB Snapshot.png]]

== '''Possible Enhancements''' ==

====='''Import functionality'''=====

The existing import implementation does not follow DRY principle, rails code practices and even basic design principles. Most of the code is written based with nested if else conditions. This implementation can be improved.
 
Exception Handling: Before starting to work on this requirement. I tried few imports and in many cases, import was not successful and i was not able to figure out what's going wrong. My suggestion would be to develop a screen to show which rows were successfully imported and the failure reason which didn't.
 
Also, if there's no team in the system and instructor has used it in the import file so a new pop up can be displayed where the new team can be created or the import can be extended to create teams while assigning the topic.
 

== '''References''' ==

1. Expertiza on GITHUB: https://github.com/expertiza/expertiza

2. GitHub Project Repository Fork: https://github.com/NisargC/expertiza

3. Demo link: http://152.46.19.138:8080/

4. Expertiza project documentation wiki: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1938._OSS_project_Duke_Blue:_Fix_import_glitches

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-10-28T19:44:04Z

Psdravid:

Issue #918 
New code introduced is as follows. 
File:app/helpers/import_topics_helper.rb 
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-10-28T19:42:43Z

Psdravid:

Issue #918
New code introduced is as follows.
File:app/helpers/import_topics_helper.rb
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches

2019-10-28T19:42:09Z

Psdravid: Created page with "Issue #918 New code introduced is as follows. File:app/helpers/import_topics_helper.rb Code: def self.define_attributes(row_hash) attributes = {} if !row_hash[:descriptio..."

Issue #918
New code introduced is as follows.
File:app/helpers/import_topics_helper.rb
Code:
def self.define_attributes(row_hash)
attributes = {}
if !row_hash[:description].nil? and !row_hash[:description].ascii_only?
row_hash[:description] = self.trim_non_ascii(row_hash[:description])
puts row_hash[:description]
end
attributes["topic_identifier"] = row_hash[:topic_identifier].strip
attributes["topic_name"] = row_hash[:topic_name].strip
attributes["max_choosers"] = row_hash[:max_choosers].strip
@@ -13,6 +17,13 @@ def self.define_attributes(row_hash)
attributes
end

def self.trim_non_ascii(string)
string.split('').each do |char|
!char.ascii_only? ? string.tr!(char, ' ') : nil
end
string.gsub!(/\s+/, ' ')
end

CSC/ECE 517 Fall 2019

2019-10-28T19:38:28Z

Psdravid:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1953. Tagging report for student]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]
* [[CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names]]
* [[CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management]]
* [[CSC/ECE 517 Fall 2019 - E1948. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams]]
* [[CSC/ECE 517 Fall 2019 - E1969. Fixes for reviews not being available]]
* [[CSC/ECE 517 Fall 2019 - E1951. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2019 - E1957. Time travel Not Allowed..!!! Restrict TAs’ ability to change their own grade + limit file-size upload]]
* [[CSC/ECE 517 Fall 2019 - E1963. Changing assignment participant role]]
* [[CSC/ECE 517 Fall 2019 - E1941. Issues related to topic deadlines]]
* [[CSC/ECE 517 Fall 2019 - E1966. Tabbed_reviews partial file refactor for displaying the alternate view of reviews]]
* [[CSC/ECE 517 Fall 2019 - E1962. Email notification upon account creation]]
* [[CSC/ECE 517 Fall 2019 - E1967. Fix glitches in author feedback]]
* [[CSC/ECE 517 Fall 2019 - E1960. Create new late policy successfully and fixing "Back" link]]
* [[CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements]]
* [[CSC/ECE 517 Fall 2019 - M1950. Support Asynchronous Web Assembly Compilation]]
* [[CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches]]