CSC/ECE 517 Fall 2016/E1680. Improve survey functionality

Introduction to Expertiza

The Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. Expertiza is an open source project and is based on “Ruby on Rails” framework. Expertiza facilitates easy creation of assignments and a list of topics for the same. Expertiza, in other words, gives a very simple web interface for assignment management for both the students as well as instructors.

Problem Statement

Overview

Expertiza should be able to distribute surveys to the users. The survey can be one of the following: 1. Course survey (all the participants of the course can take it). 2. Global survey (all the users in Expertiza can take it).
The survey can also be targeted (the admin can specify a group of people who will receive this survey).
The three kinds of surveys in this project are:

• 1. Survey questionnaire
• 2. Global survey questionnaire
• 3. Course evaluation questionnaire

Constraints

• Survey questionnaire should be a subclass of questionnaire.
• The creation, editing, filling in, and checking that all the questions have been answered survey should be similar to the procedure used for other types of questionnaires (e.g. peer-review questionnaires).
• There should be a page to see the distribution of results for any question.
• We should use the same controller method to take the survey as to fill in the peer-review, namely, response_controller.
• We should use the same code to display the existing survey responses as to display the responses in peer reviews.
• For each course or assignment, the admin/instructor should be able to create a survey and have some (or all) of the participants receive the survey.
• When a user is assigned to take part in a survey, a survey_participant record should be created for that user in the participants table.

Existing Models, Views and Controllers

Survey questionnaire, Global Survey questionnaire and course_evaluation_questionnaire are the existing models which are subclasses of questionnaire. Their display types are survey, global survey and course evaluation respectively. The controller file present currently is survey_controller.rb. Its functionalities include-

• Action can only be taken by Instructor, Teaching Assistant and Administrator.
• Surveys can be assigned with the help of an assignment id.

A survey view file is also present to assign or list the surveys.

Proposed Design

Structure

In our design we have three kinds of survey-

• survey_questionnaire
• global_survey_questionnaire
• course_evaluation_questionnaire

These models should be made as subclasses of the class survey. By using the concept of polymorphism, survey is made a subclass of survey_questionnaire as many kinds of survey_questionnaire can exist and by using polymorphism, the code can be made more efficient. Survey_questionnaire is then a subclass of questionnaire. Complete refactoring is needed as the existing code is inefficient.

Distribution of results

• There will be a page to see the distribution of results for any question (e.g., how many people answered “1”, how many answered “2”, etc.).
• This page will not only be designed for surveys, but also for other types of questionnaires (E.g. this view be able to show the score distribution for a question in other types of questionnaires, no matter whether it is a survey question like “how much do you like the course?” or a peer-review question like “how well did the author test the code?”)

Proposed Implementation

The required page for this implementation would look like this:

• Our page to see the distribution of results for any question would render a similar Bar graph
• showing the no of people who answered a choice amongst the options.
• The vertical axis would show the no of people.
• The horizontal axis will show the possible answers to the question.
• To implement this in Expertise we can use JQPlot Rails or some other graph plotting plugin.

The JQuery code might look like

• We will have to integrate the Jquery plugin and create a .erb file in views which will have similar
• Jquery code to render a bar graph based on the data provided.

Taking the survey

• There is a constraint that the survey has to be filled in using the same controller method as used for filling in peer review, namely response_controller. Also, the same code has to be used to display the existing survey responses as to display the responses in peer review.
• The response_controller can be used to make sure that the survey can be taken only once by each user, depending upon the survey type and the users who are allowed to access (can be listed using 'action_allowed?'). The answers can be saved using the 'saving' method. Also, the responses can be viewed once, the survey is submitted.

Adding Participants to the survey:

• Instructor or admin both can add survey for any course or assignment

• The creator would be able to select the participants based on the scope of the survey, that is, all the students or all the Expertiza users or specific group of people.

Adding all the global questionnaire questions:

• There would be a generic set of questions which will be included in global_survey_questionnaire.
• These questions will be by default added to every survey the user creates.
• But, creator will be able to omit them with one ‘checkbox’ button (Or, we can have specific selections for each of the questions to be included).
• Or, there can be option of separating the global survey and course survey. The quiz taker will take the global survey first and then the course survey.

Adding the data to database:

• For each participant added by the creator of the survey, a database entry would be made in participant table along with appropriate details.

Files to be modified:

Controllers

• app/controllers/survey_deployment_controller.rb
• app/controllers/statistics_controller.rb
• app/controllers/course_evaluation_controller.rb
• app/controllers/survey_controller.rb

Models

• app/models/global_survey_questionnaire.rb
• app/models/survey_questionnaire.rb
• app/models/survey_deployment.rb
• app/models/metasurvey.rb
• app/helpers/survey_helper.rb
• app/models/survey_participant.rb
• app/models/survey_response.rb
• app/helpers/survey_response_helper.rb

Views

• app/views/survey_deployment/
• app/views/statistics/
• app/views/survey_response/
• app/views/survey

Testing

Testing using UI

Login as instructor:
1. Use credentials username: instructor6, password:password.
2. Click on Manage -> Questionnaires-> Survey / Global Survey/ Course evaluation.
3. Create a new Survey/ Global Survey/ Course evaluation filling in the parameters asked for.

Login as student:
1. The course survey is for all the students, whereas the global survey is for a few random students using Expertiza.
2. Take the survey visible through your account.

New Implementation

Changing names

*Changing name of the model 'survey_questionnaire' to 'assignment_survey_questionnaire'
*Changing all the entries in the database. That involves, migration of all questionnaire entries where type="survey_questionnaire" to "assignment_survey_questionnaire".
*In our part of project implementation, there is no need to incorporate any changes to the Assignment Questionnaire. 

Deletion from previous implementation

*Deleting all traces of 'survey_deployments','survey_participants', and 'survey_responses.'

Addition

• Add columns to the 'Assignments' table: survey_id and global_survey_id.

*