Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades

2019-11-11T19:35:05Z

Amandli:

==E1984. Improve self-review Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. The Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Team and Resources===

* Team Members: Amit Mandliya, Ankit Manendra, Bharat Sinha, Daniel Mendez Lozada

===Problem Statement and Overview===

The Expertiza allows Instructors to create assignments with allowing self-review option to Students. Each member has to evaluate their submission with the same criteria as the peer review. Currently these scores are not used at all in the final scores for the submsission. The task here is to improve the self-review system pertaining to give it a weightage in the final scores for the submissions. Some of the objectives we try to achieve for this project are as follows –

*Provide a formula that takes both the peer review score and self-review score into account for calculating the composite score.
*The composite score should get higher as the self-review score gets closer to the peer review score.
*Make sure that the peer review scores are not visible before the self-review submission.
*Display the composite score on the “View Scores” page.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, showing that they are a different type of review.

The need for the self-review section is to know how well the students can judge their work and understand how to evaluate their flaws and rectify them. Also, if they can score themselves close to their peers, then it means that they have good self-assessment skills and they are being honest about what they think of their work.

===Code Changes Flow===

[[File:E1926_code_flow.png]]

===Previous Process===

Previously, Expertiza allowed students to submit an assignment and provides a link for self-review. Once the self-reviewing was done, the submitted score gets stored in the database but was not used in calculating the overall score of the assignment for the student. Because of this, students can score themselves higher than what they should get. This helps students in no way. So, to make productive use of this score and to help students learn self-evaluating, we have made some changes in the review score calculation which is explained in the section below.

===New Process===

We are trying to derive a new formula that takes into account the self-review score and calculates a composite score, which will be the student's final score:

#[https://drive.google.com/file/d/19jp7UdLCTdMhLiqsBR_ArU7gIpxYfkx_/view?usp=sharing Notes for deriving the formula]

== Testing ==
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
* Peer-reviews can be viewed immediately when self-reviews are not required.
* The derived scores can be saved to the database.
* Self-review scores are displayed with peer-review scores
* Student can only see their own self-review

CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades

2019-11-11T19:34:22Z

Amandli: /* New Process */

CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades

2019-11-11T19:31:30Z

Amandli:

==E1984. Improve self-review Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. The Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Team and Resources===

* Team Members: Amit Mandliya, Ankit Manendra, Bharat Sinha, Daniel Mendez Lozada

===Problem Statement and Overview===

The Expertiza allows Instructors to create assignments with allowing self-review option to Students. Each member has to evaluate their submission with the same criteria as the peer review. Currently these scores are not used at all in the final scores for the submsission. The task here is to improve the self-review system pertaining to give it a weightage in the final scores for the submissions. Some of the objectives we try to achieve for this project are as follows –

*Provide a formula that takes both the peer review score and self-review score into account for calculating the composite score.
*The composite score should get higher as the self-review score gets closer to the peer review score.
*Make sure that the peer review scores are not visible before the self-review submission.
*Display the composite score on the “View Scores” page.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, showing that they are a different type of review.

The need for the self-review section is to know how well the students can judge their work and understand how to evaluate their flaws and rectify them. Also, if they can score themselves close to their peers, then it means that they have good self-assessment skills and they are being honest about what they think of their work.

===Code Changes Flow===

[[File:E1926_code_flow.png]]

===Previous Process===

Previously, Expertiza allowed students to submit an assignment and provides a link for self-review. Once the self-reviewing was done, the submitted score gets stored in the database but was not used in calculating the overall score of the assignment for the student. Because of this, students can score themselves higher than what they should get. This helps students in no way. So, to make productive use of this score and to help students learn self-evaluating, we have made some changes in the review score calculation which is explained in the section below.

===New Process===

We are trying to derive a new formula that takes into account the self-review score and calculates a composite score, which will be the student's final score:

#[https://drive.google.com/file/d/1yF8A-g3p4NZpXaXReHUhavl2tsnH5KZQ/view?usp=sharing Notes fro deriving the formula]

CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades

2019-11-10T20:30:55Z

Amandli:

CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades

2019-11-10T20:29:48Z

Amandli: Created page with "==E1984. Improve self-review Link peer review & self-review to derive grades== This page provides a description of the Expertiza based Semester project. __TOC__ ===About Ex..."

CSC/ECE 517 Fall 2019

2019-11-10T19:22:28Z

Amandli:

* [[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 - Project E1943. Refactor sign up sheet controller.rb]]
* [[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]]
* [[CSC/ECE 517 Fall 2019 - M1951. Implement missing OffscreenCanvas APIs]]
* [[CSC/ECE 517 Fall 2019 - E1940. Improving email notification]]
* [[CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug]]
* [[CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb]]
* [[CSC/ECE 517 Fall 2019 - M1952. Missing DOM features project]]
* [[CSC/ECE 517 Fall 2019 - E1945. Refactor users_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1964. Export review scores for projects]]
* [[CSC/ECE 517 Fall 2019 - E1949. Write Unit Tests for Importing assignment participants and import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1944. Refactor review mapping controller]]
* [[CSC/ECE 517 Fall 2019 - E1946. Refactor Questionnaire controller]]
* [[CSC/ECE 517 Fall 2019 - E1982. Regulate changing of rubrics while projects are in progress]]
* [[CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions]]
* [[CSC/ECE 517 Fall 2019 - E1990. Integrate suggestion detection algorithm]]
* [[CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality]]
* [[CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]]
* [[CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view]]
* [[CSC/ECE 517 Fall 2019 - E1995. Weights in grade calculation]]
* [[CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.]]
* [[CSC/ECE 517 Fall 2019 - E1984. Improve self-review Link peer review & self-review to derive grades]]

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T05:05:03Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Submitted Work and Demonstration of the Project ==
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [http://152.46.19.163:8080 Link to deployed code on NCSU VCL]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://https://drive.google.com/open?id=1Xcr7tfVQU9xFmeEcR3iuIWUzuzjVsUNK Link to Video of RSpec tests of the changes]

== Files modified in Project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor (Username - instructor6, Password - password). Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment directory already exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T04:39:32Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Submitted Work and Demonstration of the Project ==
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [http://152.46.19.163:8080 Link to deployed code on NCSU VCL]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://https://drive.google.com/open?id=1Xcr7tfVQU9xFmeEcR3iuIWUzuzjVsUNK Link to Video of RSpec tests of the changes]

== Files modified in Project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment directory already exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:29:25Z

Amandli: /* Files modified in current project */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Submitted Work and Demonstration of the Project ==
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://https://drive.google.com/open?id=1Xcr7tfVQU9xFmeEcR3iuIWUzuzjVsUNK Link to Video of RSpec tests of the changes]

== Files modified in Project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment directory already exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:29:06Z

Amandli: /* References */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Submitted Work and Demonstration of the Project ==
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://https://drive.google.com/open?id=1Xcr7tfVQU9xFmeEcR3iuIWUzuzjVsUNK Link to Video of RSpec tests of the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment directory already exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:28:23Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== References ==
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://https://drive.google.com/open?id=1Xcr7tfVQU9xFmeEcR3iuIWUzuzjVsUNK Link to Video of RSpec tests of the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment directory already exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:25:22Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment directory already exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:24:40Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[Assignment_directory_already_exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

File:Assignment directory already exists.JPG

2019-10-29T02:24:19Z

Amandli:

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:21:43Z

Amandli: /* List of changes */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

<pre>
$(function() {
$("#name_field").change(function() {
filename = $( "#name_field" ).val().replace(/ /g,"_").replace(/[/\\?%*:|"<>/$&!#%^@]/g, '');;
$('#directory_field').val(filename);
});
});

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:19:44Z

Amandli: /* List of changes */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
flash.now[:error] = "This assignment/directory already exists in the selected course. Kindly rename."
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:08:59Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1:''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2:''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3:''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4:''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5:''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T02:05:46Z

Amandli: /* References */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://drive.google.com/open?id=1O81Er0QrVceDiVhHVlC57BDToVFuIgDN Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:55:19Z

Amandli: /* References */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://github.com/expertiza/expertiza/pull/1575 Link to Pull Request related to the change]
* [https://a.com Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:53:58Z

Amandli: /* References */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to Github Repository of expertiza]
* [https://github.com/anujak30/expertiza-1 Link to Github Repository of including changes related to E1954]
* [https://a.com Link to Pull Request related to the change]
* [https://a.com Link to Video showing the demonstration of the project]
* [http://a.com Link to Video of testing the changes]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:51:31Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

===References===
* [https://github.com/expertiza/expertiza Link to expertiza]
* [https://github.com/anujak30/expertiza-1 Link to changes E1954]

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:46:36Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

== Team Information ==
1) Amit Mandliya (amandli)

2) Anuja Kulkarni (apkulka2)

3) Samruddhi Khandale (sskhanda)

Mentor : Akanksha Mohan

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:44:38Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:44:02Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
'''Step 3''' Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
'''Step 4''' Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
'''Step 5''' Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 
[[File:Assignment already exists.JPG]] 
[[File:Directory exists.JPG]] 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

File:Directory exists.JPG

2019-10-29T01:43:40Z

Amandli:

File:Assignment already exists.JPG

2019-10-29T01:43:14Z

Amandli:

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:41:12Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG|200px]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
3. Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
4. Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:40:46Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
3. Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG]] 
4. Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG]] <br 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:40:16Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test assignment". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]] 
3. Fill in the details for Rubrics and Review Strategy. 
[[File:Rubrics.JPG] 
4. Click on create. You should be able to see the assignment you created in the list. 
[[File:Review.JPG] <br 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

File:Rubrics.JPG

2019-10-29T01:39:41Z

Amandli:

File:Review.JPG

2019-10-29T01:37:47Z

Amandli:

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:36:14Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]]
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:35:47Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
[[File:Login as instructor.JPG height="42" width="42"]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]]
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:35:01Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[File:Directory_name_autopopulate.JPG]]
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:34:11Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
[[File:Login as instructor.JPG]] 
'''Step 2''' Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
[[Directory_name_autopopulate.JPG]]
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

File:Directory name autopopulate.JPG

2019-10-29T01:33:53Z

Amandli:

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:32:36Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
[[File:Login as instructor.JPG|500px]] 
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:31:55Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
'''Step 1''' Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
[[File:Login as instructor.JPG]]
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

File:Login as instructor.JPG

2019-10-29T01:29:18Z

Amandli:

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:17:47Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:17:32Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 

[File:Login_Page.png]
[[File: Login_Page.png|200px]]
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:17:15Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 

[File:Login_Page.png]
[[File: Login_Page.png|200px|left|alt text]]
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:16:57Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 

[File:Login_Page.png]
[[File: Login_Page.png|200px|thumb|left|alt text]]
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:16:24Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 

[File:Login_Page.png]
[[File: Login_Page.png|frame|center]]
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T01:14:39Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 

[File:Login_Page.png]
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T00:56:15Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T00:52:24Z

Amandli:

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
[[File: Login_Page.PNG|frame|center]]
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

File:Login Page.png

2019-10-29T00:51:02Z

Amandli:

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T00:49:22Z

Amandli: /* UI Testing */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:- 
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.

CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names

2019-10-29T00:25:35Z

Amandli: /* Scope for future improvement */

This wiki page is for the description of changes made under E1954. Auto-generate submission directory names based on assignment names for Fall 2019, CSC/ECE 517.

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open-source project developed on Ruby on Rails platform and its code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the AssignmentsController and AssignmentsView - _general.html.erb. Here is the details description of the project: 
The directory name is auto-generated from the assignment name. The instructor is allowed to edit 
It is done by changing spaces in the names to underscores. E.g., the directory for Program 1 is by default "Program_1". 
The special characters like '/','\','$' etc are to be removed from the auto-generated submission directory name. 
A check is added to prevent two assignments in the same course from having the same name. 
A check is made to stop two assignments from sharing the same directory. 

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1. AssignmentsController 
2. AssignmentsView - _general.html.erb 

=== AssignmentsController ===

This is a controller that helps instructors create, modify, copy new assignments. Each assignment can be associated with specific Rubrics, Review Strategy and Due dates.

=== AssignmentsView - _general.html.erb ===

This the View for creating the new assignments and editing the existing assignments. This view also handles specifications of Rubrics, Review Strategy and Dates.

== List of changes ==
We worked on the following work items(WIs) 
WI1: Created exist_assignment and exist_directory to check if the assignment name and directory name already exists in the current course. If any of those are already present then flash the respective error, else save the assignment. Here is the create method of controller -> assignments_controller.rb: 

<pre>
def create
@assignment_form = AssignmentForm.new(assignment_form_params)
if params[:button]
# Do not create an assignment if the assignment name or directory name already present in the course
exist_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
exist_directory = Assignment.find_by(directory_path: assignment_form_params[:assignment][:directory_path], course_id: @assignment_form.assignment.course_id)
if !exist_assignment and !exist_directory
if @assignment_form.save
@assignment_form.create_assignment_node
# Get the details of the assignment which is saved in current_assignment
current_assignment = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id)
assignment_form_params[:assignment][:id] = current_assignment.id.to_s
ques_array = assignment_form_params[:assignment_questionnaire]
due_array = assignment_form_params[:due_date]
ques_array.each do |cur_questionnaire|
cur_questionnaire[:assignment_id] = current_assignment.id.to_s
end
due_array.each do |cur_due|
cur_due[:parent_id] = current_assignment.id.to_s
end
assignment_form_params[:assignment_questionnaire] = ques_array
assignment_form_params[:due_date] = due_array
@assignment_form.update(assignment_form_params, current_user)
aid = Assignment.find_by(name: @assignment_form.assignment.name, course_id: @assignment_form.assignment.course_id).id
ExpertizaLogger.info "Assignment created: #{@assignment_form.as_json}"
redirect_to edit_assignment_path aid
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
return
else
flash.now[:error] = "Failed to create assignment"
render 'new'
end
else
if exist_assignment
flash.now[:error] = "Assignment name already exists in the selected course. Kindly rename the assignment."
else
flash.now[:error] = "Directory name already exists in the selected course. Kindly rename the directory."
end
render 'new'
end
else
render 'new'
undo_link("Assignment \"#{@assignment_form.assignment.name}\" has been created successfully. ")
end
end
</pre>

WI2: Auto-generate the Submission directory name based on the assignment name. Allow, the Submission Directory name field to be explicitly editable by the instructor. Here is the javascript function introduced in views -> assignments -> edit -> _general.html.erb 

<pre>
<tr><div class="form-inline">
<td style='padding:5px'><%= label_tag('assignment_form[assignment][directory_path]', 'Submission directory:') %></td>
<td style='padding:5px'><%= text_field_tag('assignment_form[assignment][directory_path]', @assignment_form.assignment.directory_path, required: true,
:id => 'directory_field', :style => 'width:250px', class: 'form-control') %> (Note: Directory name is auto-generated from Assignment Name. You can change it if you wish to.)
<img src="/assets/info.png" title='- DO NOT change this filed for an on-going assignment. This may cause lost of student submitted file.'>
</td></div>
</tr>

</pre>

WI3: Earlier the assignment was getting generated even if the instructor was not giving it any name or submission directory path, now both of these fields have been made mandatory. 

== Testing Details==

=== RSpec ===
In the spec file for assignments controller, a check is made if the assignment which is getting created is of the name which already exists then the assignment should not be allowed to save.

=== UI Testing ===
Following Steps needs to be performed to test the project from UI:-
1. Login as Instructor. Create an assignment under any of the existing courses with name as "test name". 
2. Check if the Submission directory field is automatically getting populated based on the assignment name (replacing spaces with underscores and removing special characters). 
3. Fill in the details for Rubrics and Review Strategy. 
4. Click on create. You should be able to see the assignment you created in the list. 
5. Now, try to create another assignment with the same name in the same course. Also, try to change the submission directory name to any of the existing assignment or same the assignment created in Step 2, Check if the system flashes an error in the creation of this assignment. 

== Scope for future improvement ==
While working on this project, we identified an existing issue where if you try to edit the name of the already existing assignment to something which is the same as another existing asignment then the system breaks. This could be made another OSS topic to be worked on.