E1838 Project Red

Introduction

Problem Statement

In Expertiza, if the instructor doesn’t specify the assignment directory for a submission, the directory defaults to the home directory. This can lead to multiple assignment submissions being in the same place and creating confusion. The aim of the project if to handle all the scenarios that can arise when the instructor is not specifying any directory name.

Issues to be fixed

Issue #391: In Expertiza, if the instructor doesn’t specify the assignment directory for a submission, the directory defaults to the home directory. This can lead to multiple assignment submissions being in the same place and creating confusion. Please take a look at the Github issue for suggestions on how to solve this.

Issue #1190: An issue with conflicting directories for copied assignments was fixed. You need to write the test to verify that this issue doesn’t recur. This test should check that the assignment directories for copied assignments are distinct from the original directories.

Issue #1201: Expertiza has the feature to auto generate the directory names for submissions from the assignment name. However, this may be concerning if two assignments have the same name, in which case the submission folders would be the same and this would again create a problem. This needs to be fixed.

---

Modified Files

1) /app/views/submitted_content/_submitted_files.html.erb

2) /app/controllers/assignment_controller.rb

3) /app/views/assignments/edit/_general.html.erb

---

Approach taken to resolve the issues

Issue #391

-> When the instructor has not specified a directory path, there is no directory where the files can be stored. -> Hence we allow only links to be submitted in such an assignment. -> In the view of submitted content controller we disabled the button to upload files in such assignment where the directory path is null. -> We displayed the message 'Fie submissions are disabled' whenever anyone tries to upload files to such assignment.

Pseudo Code:

   Added following logic in /app/views/submitted_content/_submitted_files.html.erb

     <% if @assignment.directory_path != "" %>
       <% puts "Assign Directory: #{@assignment.directory_path}" %>
       <%= submit_tag 'Upload file', class: 'btn btn-default' %>
     <% else %>
       <%= 'File Submissions are disabled' %>
     <%end%>

Explanation: If the assignment directory path is specified by the instructor then the button to upload files will be displayed else the warning message 'File submissions are disabled will be displayed'.

Issue #1201

Expertiza has the feature to auto generate the directory names for submissions from the assignment name. However, this may be concerning if two assignments have the same name, in which case the submission folders would be the same and this would again create a problem.

Approach taken to solve the issue: Logic for Auto generation of the directory names: Append assignment_name, assignment_id, course_id to make the directory name unique.

Files modified:

/app/controllers/assignment_controller.rb

/app/views/assignments/edit/_general.html.erb

1) /app/views/assignments/edit/_general.html.erb

Pseudo code:

<input type="checkbox" name="assignment_form[check_validate]" /> File submissions are allowed?

Explanation: Added a checkbox in the view for creating an assignment. An instructor can select if file submissions are allowed. If he selects 'yes' then if the instructor has given an empty directory path, the name of the directory for the assignment will be auto generated.

2) /app/controllers/assignment_controller.rb

     if quesparams[:assignment][:directory_path] == "" and quesparams[:check_validate] == "on"
       quesparams[:assignment][:directory_path] = "#{quesparams[:assignment][:name]}_#{quesparams[:assignment][:id]}_#{quesparams[:assignment][:course_id]}"
     end

Explanation: If the check box is checked, it will pass the value "on" to the assignment controller and the directory name will be auto generated.

How to Test

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2

issue #391 and issue #1201

Steps to test Issue #391 and #1201

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details

5) Select if you want to allow file submissions

6) If 'yes', then file directory name will be auto generated as assignment_name+assignment_id+course_name

7) If 'no'

8) Login as a student and you can see that only links can be submitted and file submissions are disabled since the directory is not specified

Automated tests for Issue #391 and #404

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path:

   1)describe 'check_directory_path' do:
   2)    it 'returns false if directory path already in use' do:
   3)        @assignment = create(:assignment)
   4)        expect(@assignment.check_directory_path).to eql(false)
   5)    end
   6)end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment:

1)it 'is not valid without directory_path' do
2)    assignment.directory_path = nil
3)    assignment.should_not be_valid
4)end

3) To check if after assigning course to an assignment is the directory path updated to contain the course path:

1)it 'should contain course in path name' do
2)    @assignment = create(:assignment)
3)    @assignment.directory_path = Course.first.directory_path.to_s + "/finaltest"
4)    expect(@assignment.directory_path).to include(Course.first.directory_path)
5)end

• • To test the changes clone the following repository https://github.com/daxamin/expertiza .