User:Vchheda

E2321. Reimplement QuestionnairesController and QuestionsController

Problem Statement

The questionnaire is the superclass for all kinds of questionnaires and rubrics. Rubrics are used for evaluating submissions and teammate contributions, as well as taking quizzes and surveys, and all of these are subclasses of the Questionnaire class. In Expertiza, various types of questionnaires can be created, such as the Survey Questionnaire, Author Feedback Questionnaire, Bookmark Rating Questionnaire, Metareview Questionnaire, Quiz Questionnaire, Review Questionnaire, and Teammate Review Questionnaire. Each of these questionnaires can have zero or more questions, which are represented by the Question class. Typically, a questionnaire is associated with an assignment using the Assignment class.

The Questionnaire Controller is responsible for performing CRUD (Create, Read, Update, Delete) operations, such as copying and viewing questionnaires. On the other hand, the Questions Controller is responsible for creating, modifying, and deleting individual questions within a questionnaire. Questions can come in various types, such as checkboxes, multiple choice, text boxes, and more. However, each question object will always belong to a particular questionnaire. However, the current implementation suffers from several issues, such as mixing the responsibilities of the two controllers, using methods with identical names for different functionalities, and unclear or unused functionalities. Therefore, to improve the code quality and functionality, the two controllers should be implemented separately and adhere to the CRUD operations as much as possible. Additionally, the code needs to be refactored and optimized for better performance, and unused or unclear methods should be discarded. Finally, comprehensive tests should be written to ensure that the code is functioning correctly and free of code smells.

Goals of this Project

The goals of this Project are:

• Separating the responsibilities of the Questionnaire Controller and Questions Controller:

The first step is to write controllers for the Questionnaires and Questions, which will be responsible for creating, modifying, and deleting questions. The Questionnaire Controller will only be responsible for CRUD operations related to questionnaires.

• Fix bugs in the existing functionality:

Delete questionnaire option not working, redirect to the view page after creation of a questionnaire, Update questionnaire not working for updating parameters of the questionnaire and update not working on questionnaire if it has zero questions.

• Implementing CRUD operations for each controller:

Each controller should have only CRUD operations as far as possible. The Questionnaire Controller should have methods for creating, updating, deleting, and viewing questionnaires. Similarly, the Questions Controller should have methods for creating, updating, deleting, and viewing questions.

• Improving the clarity and conciseness of code:

The code should be written in a clean and concise manner. Methods with identical names that perform different functionalities should be renamed for clarity. Functions or functionality that are not clear should be commented on or removed. Any loops or methods that can be refactored for better performance should be addressed e.g. delete all questions that belong to a questionnaire

• Discarding unused or unclear functionality:

Any unused or unclear functionality should be removed from the controllers. This will help to reduce complexity and make the code easier to maintain.-

• Writing tests for the two controllers:

Tests should be written for both the Questionnaire Controller and the Questions Controller. The tests should cover at least 80% of the code, and tools like Rubocop and Code Climate should be used to verify code smells.

By achieving these goals, both the controllers can have their basic CRUD functionalities as well as it will also ensure that the code readability and functionality of the code for the two controllers is increased. It will also help in resolving the existing bugs which will increase correctness of the code.

Initial code of Questionnaire and Questions Controller

1. Questionnaire Controller

2. Question Controller

Proposed Changes

• Solution: - Separating the responsibilities of the Questionnaire Controller and Questions Controller:

Initially the add_new_questions method present in questionnaire controller was responsible for adding a new question for the given questionnaire. As questions controller is responsible for creating a question, we defined a create method in questions controller which is responsible for the adding a new question for a given questionnaire. Since, to link a question to a questionnaire, we passed questionnaire id using params and linked a new question created with the help of create method in questions controller to the required questionnaire and thus separated their responsibilities.

• Solution: - Implementing CRUD operations for each controller:

After separating the functionalities of the two controller, the CRUD operations for each controller are :- 1. Questionnaire Controller -

2. Question Controller -

• Solution:- Writing tests for the two controllers:

1. Questionnaire Controller

1. Tests for Questionnaire Controller

require 'swagger_helper' RSpec.describe 'Questionnaire API', type: :request do

 path '/api/v1/questionnaire' do
   get('list questionnaires') do
     tags 'Questionnaires'
     produces 'application/json'

     response(200, 'successful') do

       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end

     response(422, 'invalid request') do
       let(:questionnaire) { { name: , min_question_score: 1, max_question_score: 5,type: "" } }
       
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end

   post('create questionnaire')do
     tags 'Questionnaires'
     consumes 'application/json'
     parameter name: :questionnaire, in: :body, schema: {
       type: :object,
       properties: {
         name: { type: :string },
         type: { type: :string },
         min_question_score: { type: :integer },
         max_question_score: { type: :integer }
       },
       required: [ 'name', 'type', 'min_question_score', 'max_question_score' ]
     }
 
     response(201, 'Created a questionnaire') do
       let(:questionnaire) { { name: 'Questionnaire 1', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } }
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
 
     response(422, 'invalid request') do
       let(:questionnaire) { { name: , type: 'AuthorFeedbackQuestionnaire',min_question_score: 1, max_question_score: 5 } }
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
 end

 path '/api/v1/questionnaires/{id}' do
   parameter name: 'id', in: :path, type: :integer, description: 'ID of the questionnaire'
 
   get('show questionnaire') do
     tags 'Questionnaires'
     consumes 'application/json'
     produces 'application/json'
     parameter name: :questionnaire, in: :body, schema: {
       type: :object,
       properties: {
         id: { type: :integer },
         name: { type: :string },
         private: { type: :boolean },
         instructor_id: { type: :integer },
         min_question_score: { type: :integer },
         max_question_score: { type: :integer },
         type: { type: :string },
         display_type: { type: :string },
         instruction_loc: { type: :string },
         created_at: { type: :string, format: :date_time },
         updated_at: { type: :string, format: :date_time }
       }
       required: [ 'name', 'type', 'min_question_score', 'max_question_score' ]
     }
 
     response(200, 'successful') do
       let(:id) { questionnaire.id }
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
 
       run_test!
     end
 
     response(404, 'questionnaire not found') do
       let(:id) { -1 }
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
 
       run_test!
     end
   end

   patch('update questionnaire') do
     tags 'Questionnaires'
     consumes 'application/json'
     parameter name: :questionnaire, in: :body, schema: {
       type: :object,
       properties: {
         id: { type: :integer },
         name: { type: :string },
         private: { type: :boolean },
         instructor_id: { type: :integer },
         min_question_score: { type: :integer },
         max_question_score: { type: :integer },
         type: { type: :string },
         display_type: { type: :string },
         instruction_loc: { type: :string },
         created_at: { type: :string, format: :date_time },
         updated_at: { type: :string, format: :date_time }
       }
       required: [ 'name', 'type', 'min_question_score', 'max_question_score' ]
     }
 
     response(200, 'successful') do
       let(:id) { Questionnaire.create({ name: 'Questionnaire150', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } ).id }
       let(:questionnaire) { { name: 'Questionnaire100', type: 'AuthorFeedbackQuestionnaire',min_question_score: 1, max_question_score: 5 } }
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
 
     response(422, 'invalid request') do
       let(:id) { Questionnaire.create({ name: 'Questionnaire150', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } ).id }
       let(:questionnaire) { { name: , type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
   
   put('update questionnaire') do
     tags 'Questionnaires'
     consumes 'application/json'
     parameter name: :questionnaire, in: :body, schema: {
       type: :object,
       properties: {
         id: { type: :integer },
         name: { type: :string },
         private: { type: :boolean },
         instructor_id: { type: :integer },
         min_question_score: { type: :integer },
         max_question_score: { type: :integer },
         type: { type: :string },
         display_type: { type: :string },
         instruction_loc: { type: :string },
         created_at: { type: :string, format: :date_time },
         updated_at: { type: :string, format: :date_time }
       }
       required: [ 'name', 'type', 'min_question_score', 'max_question_score' ]
     }
   
     response(200, 'successful') do
       let(:id) { Questionnaire.create({ name: 'Questionnaire100', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } ).id }
       
       let(:questionnaire) { { name: 'Questionnaire101', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 }  }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   
     response(422, 'invalid request') do
       let(:id) { Questionnaire.create({ name: 'Questionnaire150', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } ).id }
       let(:questionnaire) { { name: , type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
   
  
   delete('delete Questionnaire') do
     tags 'Questionnaires'
     response(200, 'successful') do
       let(:id) { '123' }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   
     response(404, 'not found') do
       let(:id) { 'invalid_id' }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
   
 end

 path '/api/v1/questionnaires/copy/{id}' do
   post('copy questionnaire') do
     tags 'Questionnaires'
     consumes 'application/json'
     parameter name: :questionnaire, in: :body, schema: {
       type: :object,
       properties: {
         name: { type: :string },
         type: { type: :string },
         private: { type: :boolean },
         min_question_score: { type: :integer },
         max_question_score: { type: :integer }
       },
       required: [ 'name', 'type', 'min_question_score', 'max_question_score' ]
     }
   
     response(200, 'successful') do
       let(:questionnaire) { { name: 'Questionnaire 1', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } }
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   
     response(500, 'server error') do
       let(:questionnaire) { { name: 'Questionnaire 1', type: 'AuthorFeedbackQuestionnaire', min_question_score: 1, max_question_score: 5 } }
 
       before do
         allow(Questionnaire).to receive(:copy_questionnaire_details).and_raise(StandardError)
       end
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
   

 end

end

2. Question Controller

1. Tests for Question Controller

require 'swagger_helper' RSpec.describe 'Question API', type: :request do

 path '/api/v1/question' do
   get('list questions') do
     tags 'Questions'
     produces 'application/json'

     response(200, 'successful') do

       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end

     response(422, 'invalid request') do
       #need to check and update this
       let(:question) { { id: 6, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: 'Dropdown' } } }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
 
   post('create question') do
     tags 'Questions'
     consumes 'application/json'
     parameter name: :question, in: :body, schema: {
       type: :object,
       properties: {
         id: { type: :integer },
         question: {
           type: :object,
           properties: {
             txt: { type: :string },
             weight: { type: :integer },
             questionnaire_id: { type: :integer },
             seq: { type: :string },
             size: { type: :string },
             alternatives: { type: :string },
             break_before: { type: :boolean },
             max_label: { type: :string },
             min_label: { type: :string },
             type: { type: :string },
           },
           required: ['type' ]
         }
       },
       required: [ 'question' ]
     }
   
     response(201, 'Created a question') do
       let(:question) { { id: 6, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: 'Dropdown' } } }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   
     response(422, 'Invalid request') do
       let(:question) { { question: { txt: , questionnaire_id: 692, seq: '9.0', type: 'Dropdown' } } }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
   
 end
 
 path '/api/v1/questions/{id}' do
   parameter name: 'id', in: :path, type: :integer, description: 'ID of the question'

   get('show question') do
     tags 'Questions'
     consumes 'application/json'
     parameter name: :question, in: :body, schema: {
       type: :object,
       properties: {
         id: { type: :integer },
         question: {
           type: :object,
           properties: {
             txt: { type: :string },
             weight: { type: :integer },
             questionnaire_id: { type: :integer },
             seq: { type: :string },
             size: { type: :string },
             alternatives: { type: :string },
             break_before: { type: :boolean },
             max_label: { type: :string },
             min_label: { type: :string },
             type: { type: :string },
           },
           required: ['type' ]
         }
       },
       required: [ 'question' ]
     }
   
     response(200, 'successful') do
       let(:id) { question.id }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
   
       run_test!
     end
   
     response(404, 'question not found') do
       let(:id) { -1 }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
   
       run_test!
     end
   end
   

   patch('update question') do
     tags 'Questions'
     consumes 'application/json'
     parameter name: :question, in: :body, schema: {
       type: :object,
       properties: {
         id: { type: :integer },
         question: {
           type: :object,
           properties: {
             txt: { type: :string },
             weight: { type: :integer },
             questionnaire_id: { type: :integer },
             seq: { type: :string },
             size: { type: :string },
             alternatives: { type: :string },
             break_before: { type: :boolean },
             max_label: { type: :string },
             min_label: { type: :string },
             type: { type: :string },
           },
           required: ['type' ]
         }
       },
       required: [ 'question' ]
     }
 
     response(200, 'successful') do
       let(:question) { { id: 6, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: 'Dropdown' } } }

       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
 
     response(422, 'invalid request') do
       let(:question) { { id: 6, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: nil } } }
   
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
 
     response(404, 'question not found') do
       let(:question) { { id: -1, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: 'Dropdown' } } }
   
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end

   put('update question') do
     tags 'Questions'
     consumes 'application/json'
     parameter name: :question, in: :body, schema: {
       type: :object,
       properties: {
         id: { type: :integer },
         question: {
           type: :object,
           properties: {
             txt: { type: :string },
             weight: { type: :integer },
             questionnaire_id: { type: :integer },
             seq: { type: :string },
             size: { type: :string },
             alternatives: { type: :string },
             break_before: { type: :boolean },
             max_label: { type: :string },
             min_label: { type: :string },
             type: { type: :string },
           },
           required: ['type' ]
         }
       },
       required: [ 'question' ]
     }
 
     response(200, 'successful') do
       let(:question) { { id: 6, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: 'Dropdown' } } }

       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
 
     response(422, 'invalid request') do
       let(:question) { { id: 6, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: nil } } }
   
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
 
     response(404, 'question not found') do
       let(:question) { { id: -1, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: 'Dropdown' } } }
   
 
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
   
   delete('delete Question') do
     tags 'Questions'
     response(200, 'successful') do
       let(:question) { { id: 6, question: { txt: 'This is a test', weight: 1, questionnaire_id: 692, seq: '9.0', size: nil, alternatives: nil, break_before: true, max_label: nil, min_label: nil, type: 'Dropdown' } } }
       let(:id) { question.id }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   
     response(404, 'not found') do
       let(:id) { 'invalid_id' }
   
       after do |example|
         example.metadata[:response][:content] = {
           'application/json' => {
             example: JSON.parse(response.body, symbolize_names: true)
           }
         }
       end
       run_test!
     end
   end
   
 
 
 end  

end

Relevant Links

• Github Repository:
• Pull Request:
• VCL Server:

Contributors

This feature was created as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Vineet Vimal Chheda, Rohan Shah, and Aditya Srivastava. Our project mentor was Ankur Mundra (amundra@ncsu.edu)