Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E17A3 Upgrade review input UI and sanitize text input

2017-12-01T20:02:46Z

Mmsatar2: /* Test Plan */

==Introduction==

====About Expertiza====

Expertiza is an open source project developed by North Carolina State University using Ruby on Rails. It is mainly a tool used to collaborate among students and faculty on a course and act as a common repository to track students’ progress on assignments. It is a simple tool where the instructor creates multiple assignments required and teams are assigned projects. Students submit their work and review other’s work and provide feedback.

Wiki link:
http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

Github link:
https://github.com/expertiza/expertiza

==Problem Statement==

1. The current Expertiza UI for reviewing uses a simple html text area for each criterion, which starting to look dull for the users. We would like you to improve the feel and look UI for the reviewers by applying CSS styling and arrange the layout of the questions/controls as the instructor designed in rubric designer (the rubric designer is currently being built by Michael Moran please contact him to get the specification of the data model).

2. Moreover, the current form still uses plain old HTML form that sent the text entered in several text areas to the controller only after the user clicks the submit button. The problem with this approach is that the reviewers sometimes lose their reviews when the page is accidentally refreshed, or when a session is broken because they take too much time writing the reviews.

3. Another problem is that the reviewers might enter their reviews from a browser with a different encoding than UTF-8. This prevents Expertiza to store the data since the database is only set up to store UTF-8 strings. Moreover, we found that the review text contains misspelled words and incorrect use of English grammar that makes the review hard to understand.

Updates in requirements as of 11 November, 2017

4.Replace the text area with a rich text editor that allows user to customize the fonts, bold, insert link to images / videos (possibly generate a thumbnails of the links).

====Possible Extension====

1. Apply CSS styling and arrange the layout of the questions/controls in view/response/response.html.erb as the instructor designed in rubric designer.

'''Approach:''' Our approach is still to keep the form simple but more responsive using bootstrap. Current form layout is a plain HTML layout and breaks when accessed through different types of devices but the desktop. The new layout will give the user a better user experience while submitting reviews through desktop, mobile or tablet. Please refer to wireframes section to view the changes in the layout of the review form.
To achieve this we will be using bootstrap 3 gems, compatible with rails 4.2.

2. Automatically save the draft versions of all inputs and restore users draft and resume their reviewing when they accidentally close or refresh the current page.

'''Approach:'''
The current design of the system clears all the data in the text fields once a session for user has been ended. We were briefed to change this design so that someone who was halfway through a review could complete it at a later time even if they ended the current browser session without saving manually.

We are making an AJAX call to save user entered text from the current text box as soon as user switches to next text box.

3. Checking the text content.

'''UTF-8''' :To solve UTF-8 encoding problem, we can make a form accept only UTF-8 characters by using an attribute of the form tag. But most of the characters, including a lot of characters from languages other than English, are present in UTF-8 character set so the application will work perfectly fine on just allowing UTF-8 characters in the text box. Below is the code snippet on the same.

<pre><form action="/action" accept-charset="UTF-8"> </pre>

'''Spellcheck :'''Since we have used rich text format, spellcheck is being handled by the same and we have just enabled the spellcheck option for the browser.

==Wireframes==
Our approach is still to keep the form simple but more responsive using bootstrap.This will give the user a better user experience while submitting reviews through desktop, mobile or tablet. Below is the design of our planned UI.

'''''1. Review form layout with select and text area.'''''
[[File:Review1.png]]

'''''2. Review form layout with checkboxes.'''''

[[File:Review2.png]]

'''''3. Review form layout with buttons and input.'''''

[[File:Review3.png]]

==Test Plan==

Test Cases planned to be implemented:

1. Field Widths – If the screen contains text boxes that allow data entry and the width of data entered does not exceed the width of the form.

2. Save and Submit Review – If the screen has the save and submit review buttons.

3. Cosmetic Inconsistencies – The screen look, feel and design should match the other screens in your application.

4. Grammar and Spelling – Ensure that you have test cases that look for grammar or spelling errors.

5. Error Messages – Ensure that error messages are informative, grammatically correct, and not condescending.

6. Screen Font Type - Ensure that the screen font family matches from screen to screen.

7. Backlink - Ensure that backlink is present on the screen.

8. Review draft is saved - Ensure that user draft version is saved automatically in every 30 seconds.

CSC/ECE 517 Fall 2017/E17A3 Upgrade review input UI and sanitize text input

2017-12-01T19:45:04Z

Mmsatar2: /* Test Plan */

CSC/ECE 517 Fall 2017/E17A3 Upgrade review input UI and sanitize text input

2017-11-08T04:04:25Z

Mmsatar2:

==Introduction==

====Description of project====

==Problem Statement==

1. The current Expertiza UI for reviewing uses a simple html text area for each criterion, which starting to look dull for the users. We would like you to improve the feel and look UI for the reviewers by applying CSS styling and arrange the layout of the questions/controls as the instructor designed in rubric designer (the rubric designer is currently being built by Michael Moran please contact him to get the specification of the data model).

2. Moreover, the current form still uses plain old HTML form that sent the text entered in several text areas to the controller only after the user clicks the submit button. The problem with this approach is that the reviewers sometimes lose their reviews when the page is accidentally refreshed, or when a session is broken because they take too much time writing the reviews.

3. Another problem is that the reviewers might enter their reviews from a browser with a different encoding than UTF-8. This prevents Expertiza to store the data since the database is only set up to store UTF-8 strings. Moreover, we found that the review text contains misspelled words and incorrect use of English grammar that makes the review hard to understand.

====Possible Extension====

1. Apply CSS styling and arrange the layout of the questions/controls in view/response/response.html.erb as the instructor designed in rubric designer.

Approach:

2. Automatically saving the draft versions of all inputs in the reviewing UI when the values are changed.

Approach:

3. Restore users draft and resume their reviewing when they accidentally close or refresh the current page.

Approach:
The current design of the system clears all the data in the text fields once a session for user has been ended. We were briefed to change this design, so that someone who was halfway through a review could complete it at a later time even if they ended the current browser session.

Javascript has a functionality to save localStorage, so that each session has the data stored upto 5MB beyond end of page session. This feature has nothing to do with Rails directly, but localStorage can be dynamically kept in rails using javascript function assignment.

localStorage.setItem("company_id", "<%= @company.id %>");

This was the example shown to properly use this feature.

4. Checking the text content.

Approach

==Wireframes==

==Test Plan==

CSC/ECE 517 Fall 2017/E1749 TFD questionnaire controller.rb refactor

2017-11-08T03:50:06Z

Mmsatar2:

== About ==
Expertiza is a website that is used and developed by NCSU students and faculty. Coded using Ruby on Rails the source code is readily available on Github -> https://github.com/expertiza/expertiza. The website is used by students for organizing teams, signing up for topics, reviewing other teams and another bunch of tasks. The faculty i.e. Instructors and TAs use this website to set new tasks, add new questions and a few other tasks.

== Team Members ==

*Shreyas Zagade
*Mohit Satarkar
*Darshan Bhandari

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Files involved==

# questionnaire_controller.rb
# questionnaire_controller_spec.rb

==Issues==

:* questionnaires_controller.rb is a fairly complex file. 
:* It contains a lot of methods that are long and hard to understand, these methods need to be broken down into simpler and more specific methods that are easier to read/understand. 
:* Also, the few instances of code duplication that exist should be removed.

== Tasks assigned ==
# Complete pending tests in questionnaires_controller_spec.rb, and write integration tests for newly-created methods. Please finish one set of pending tests first before refactoring corresponding methods.
# Refactor create method
#* Write failing tests first
#* Split into several simpler methods and assign reasonable names
#* Extract duplicated code into separate methods
# Refactor update_quiz, save_choices method
#* Write failing tests first.
#* Use polymorphism to replace the long switch statements
#** Move if conditions to corresponding subclasses (eg. MultipleChoiceCheckbox.rb, MultipleChoiceRadio.rb) with same method name
#** Replace the conditional with the relevant method calls
#** Remove duplicated code
# Use find_by instead of dynamic method
#* Write failing tests first
#* L68, L385, L386, L559, L560

== Tasks Completed ==

*Testing
*Refactoring
 

'''Testing'''
----
 
1) Completed test cases for create 

:When test case was pending
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire'
end

:After writing test case
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire' do
tree_folder1 = double('TreeFolder')
allow(tree_folder1).to receive(:id).and_return(1)
allow(tree_folder1).to receive(:node_object_id).and_return(1)
tree_folder2 = double('TreeFolder')
allow(tree_folder2).to receive(:id).and_return(1)
allow(tree_folder2).to receive(:node_object_id).and_return(1)
allow(TreeFolder).to receive(:where).with(["name like ?", "Review"]).and_return([tree_folder1, tree_folder2])
folder_node2 = double('FolderNode')
allow(folder_node2).to receive(:id).and_return(1)
allow(FolderNode).to receive(:find_by_node_object_id).and_return(folder_node2)
user = double("User")
allow(user).to receive(:id).and_return(1)
params = {
questionnaire: {
private: "true",
type: "ReviewQuestionnaire",
name: "Random Name",
min_question_score: "0",
max_question_score: "5"
}
}
session = {user: user}
get :create, params, session
expect(flash[:success]).to eq("You have successfully created a questionnaire!")
response.should redirect_to(edit_questionnaire_path(id: 1))
end
end

2) Completed test cases for update_quiz 

:When test case was pending

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page'
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page'
# params = {
# id: 1,
# pid: 1,
# save: true,
# questionnaire: {
# name: 'test questionnaire',
# instructor_id: 6,
# private: 0,
# min_question_score: 0,
# max_question_score: 5,
# type: 'ReviewQuestionnaire',
# display_type: 'Review',
# instructor_loc: ''
# },
# question: {
# '1' => {txt: 'Q1'},
# '2' => {txt: 'Q2'},
# '3' => {txt: 'Q3'}
# },
# quiz_question_choices: {
# '1' => {MultipleChoiceRadio:
# {:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
# '2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
# '3' => {MultipleChoiceCheckbox:
# {'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
# '3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
# }
# }
end
end

:After writing test case

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page' do
params = {
id: 1,
pid: 1
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page' do
params = {
id: 3,
pid: 1,
save: true,
questionnaire: {
name: 'test questionnaire',
instructor_id: 6,
private: 0,
min_question_score: 0,
max_question_score: 5,
type: 'ReviewQuestionnaire',
display_type: 'Review',
instructor_loc: ''
},
question: {
'1' => {txt: 'Q1'},
'2' => {txt: 'Q2'},
'3' => {txt: 'Q3'}
},
quiz_question_choices: {
'1' => {MultipleChoiceRadio:
{:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
'2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
'3' => {MultipleChoiceCheckbox:
{'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
'3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
}
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end
end

'''Refactoring'''
----
 

*Create method has been split into two methods create and save_questionnaire_create

'''Before Modification:'''
def create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
begin
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

'''After Modification:'''

def create
begin
save_questionnaire_create
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

def save_questionnaire_create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
end

We have also refactored the update_quiz and save_choices method, by implementing the instructions assigned to us for changing their ideology. Both of these had very long switch statements, which could be much shorter and keep optimum functionality. But the use of Polymorphism to change the way the method worked turned out to be much better.

The use of find_by instead of dynamic use was helpful. First we needed to complete the test cases at multiple mentioned line numbers. After hat, we were able to properly employ the methods as and when they were required.

We have displayed examples wherever appropriate, and the code we have uploaded on github is more than sufficient to enlighten about the changes that have been carried out.

==Test Plan==
For testing methods, we don't have to check the preconditions, as we have been assigned with refactoring the methods and testing those refactored methods properly.

We check the file questionnaires_controller_spec.rb, and test the methods required to be refactored based on our modifications we have to carry out in the spec file for the testing methods.

{| class="wikitable"
|-
! Methods
! Contexts
|-
| view
| Properly checks the rendering of questionnaires
|-
| new
| Looks for system reaction to presence of whitespace
|-
| new
| Tests the system reaction to absence of whitespace
|-
| create
| Checks if newly created page can be edited for values.
|-
| update_quiz
| Checks if the content in the questionnaire is nil
|-
| update_quiz
| Also tests if the content in the questionnaire is not nil
|-
| copy, copy_questionnaire_details, assign_instructor_id
| Tested the redirection to the view page of the copied questionnaire
|-

CSC/ECE 517 Fall 2017/E1749 TFD questionnaire controller.rb refactor

2017-11-02T05:52:36Z

Mmsatar2: /* Test Plan */

== About ==
Expertiza is a website that is used and developed by NCSU students and faculty. Coded using Ruby on Rails the source code is readily available on Github -> https://github.com/expertiza/expertiza. The website is used by students for organizing teams, signing up for topics, reviewing other teams and another bunch of tasks. The faculty i.e. Instructors and TAs use this website to set new tasks, add new questions and a few other tasks.

== Team Members ==

*Shreyas Zagade
*Mohit Satarkar
*Darshan Bhandari

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Files involved==

# questionnaire_controller.rb
# questionnaire_controller_spec.rb

==Issues==

:* questionnaires_controller.rb is a fairly complex file. 
:* It contains a lot of methods that are long and hard to understand, these methods need to be broken down into simpler and more specific methods that are easier to read/understand. 
:* Also, the few instances of code duplication that exist should be removed.

== Tasks assigned ==
# Complete pending tests in questionnaires_controller_spec.rb, and write integration tests for newly-created methods. Please finish one set of pending tests first before refactoring corresponding methods.
# Refactor create method
#* Write failing tests first
#* Split into several simpler methods and assign reasonable names
#* Extract duplicated code into separate methods
# Refactor update_quiz, save_choices method
#* Write failing tests first.
#* Use polymorphism to replace the long switch statements
#** Move if conditions to corresponding subclasses (eg. MultipleChoiceCheckbox.rb, MultipleChoiceRadio.rb) with same method name
#** Replace the conditional with the relevant method calls
#** Remove duplicated code
# Use find_by instead of dynamic method
#* Write failing tests first
#* L68, L385, L386, L559, L560

== Tasks Completed ==

*Testing
*Refactoring
 

'''Testing'''
----
 
1) Completed test cases for create 

:When test case was pending
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire'
end

:After writing test case
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire' do
tree_folder1 = double('TreeFolder')
allow(tree_folder1).to receive(:id).and_return(1)
allow(tree_folder1).to receive(:node_object_id).and_return(1)
tree_folder2 = double('TreeFolder')
allow(tree_folder2).to receive(:id).and_return(1)
allow(tree_folder2).to receive(:node_object_id).and_return(1)
allow(TreeFolder).to receive(:where).with(["name like ?", "Review"]).and_return([tree_folder1, tree_folder2])
folder_node2 = double('FolderNode')
allow(folder_node2).to receive(:id).and_return(1)
allow(FolderNode).to receive(:find_by_node_object_id).and_return(folder_node2)
user = double("User")
allow(user).to receive(:id).and_return(1)
params = {
questionnaire: {
private: "true",
type: "ReviewQuestionnaire",
name: "Random Name",
min_question_score: "0",
max_question_score: "5"
}
}
session = {user: user}
get :create, params, session
expect(flash[:success]).to eq("You have successfully created a questionnaire!")
response.should redirect_to(edit_questionnaire_path(id: 1))
end
end

2) Completed test cases for update_quiz 

:When test case was pending

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page'
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page'
# params = {
# id: 1,
# pid: 1,
# save: true,
# questionnaire: {
# name: 'test questionnaire',
# instructor_id: 6,
# private: 0,
# min_question_score: 0,
# max_question_score: 5,
# type: 'ReviewQuestionnaire',
# display_type: 'Review',
# instructor_loc: ''
# },
# question: {
# '1' => {txt: 'Q1'},
# '2' => {txt: 'Q2'},
# '3' => {txt: 'Q3'}
# },
# quiz_question_choices: {
# '1' => {MultipleChoiceRadio:
# {:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
# '2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
# '3' => {MultipleChoiceCheckbox:
# {'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
# '3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
# }
# }
end
end

:After writing test case

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page' do
params = {
id: 1,
pid: 1
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page' do
params = {
id: 3,
pid: 1,
save: true,
questionnaire: {
name: 'test questionnaire',
instructor_id: 6,
private: 0,
min_question_score: 0,
max_question_score: 5,
type: 'ReviewQuestionnaire',
display_type: 'Review',
instructor_loc: ''
},
question: {
'1' => {txt: 'Q1'},
'2' => {txt: 'Q2'},
'3' => {txt: 'Q3'}
},
quiz_question_choices: {
'1' => {MultipleChoiceRadio:
{:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
'2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
'3' => {MultipleChoiceCheckbox:
{'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
'3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
}
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end
end

'''Refactoring'''
----
 

*Create method has been split into two methods create and save_questionnaire_create

'''Before Modification:'''
def create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
begin
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

'''After Modification:'''

def create
begin
save_questionnaire_create
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

def save_questionnaire_create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
end

==Test Plan==
For testing methods, we don't have to check the preconditions, as we have been assigned with refactoring the methods and testing those refactored methods properly.

We check the file questionnaires_controller_spec.rb, and test the methods required to be refactored based on our modifications we have to carry out in the spec file for the testing methods.

{| class="wikitable"
|-
! Methods
! Contexts
|-
| view
| Properly checks the rendering of questionnaires
|-
| new
| Looks for system reaction to presence of whitespace
|-
| new
| Tests the system reaction to absence of whitespace
|-
| create
| Checks if newly created page can be edited for values.
|-
| update_quiz
| Checks if the content in the questionnaire is nil
|-
| update_quiz
| Also tests if the content in the questionnaire is not nil
|-
| copy, copy_questionnaire_details, assign_instructor_id
| Tested the redirection to the view page of the copied questionnaire
|-

CSC/ECE 517 Fall 2017/E1749 TFD questionnaire controller.rb refactor

2017-11-02T05:49:58Z

Mmsatar2: /* Test Plan */

== About ==
Expertiza is a website that is used and developed by NCSU students and faculty. Coded using Ruby on Rails the source code is readily available on Github -> https://github.com/expertiza/expertiza. The website is used by students for organizing teams, signing up for topics, reviewing other teams and another bunch of tasks. The faculty i.e. Instructors and TAs use this website to set new tasks, add new questions and a few other tasks.

== Team Members ==

*Shreyas Zagade
*Mohit Satarkar
*Darshan Bhandari

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Files involved==

# questionnaire_controller.rb
# questionnaire_controller_spec.rb

==Issues==

:* questionnaires_controller.rb is a fairly complex file. 
:* It contains a lot of methods that are long and hard to understand, these methods need to be broken down into simpler and more specific methods that are easier to read/understand. 
:* Also, the few instances of code duplication that exist should be removed.

== Tasks assigned ==
# Complete pending tests in questionnaires_controller_spec.rb, and write integration tests for newly-created methods. Please finish one set of pending tests first before refactoring corresponding methods.
# Refactor create method
#* Write failing tests first
#* Split into several simpler methods and assign reasonable names
#* Extract duplicated code into separate methods
# Refactor update_quiz, save_choices method
#* Write failing tests first.
#* Use polymorphism to replace the long switch statements
#** Move if conditions to corresponding subclasses (eg. MultipleChoiceCheckbox.rb, MultipleChoiceRadio.rb) with same method name
#** Replace the conditional with the relevant method calls
#** Remove duplicated code
# Use find_by instead of dynamic method
#* Write failing tests first
#* L68, L385, L386, L559, L560

== Tasks Completed ==

*Testing
*Refactoring
 

'''Testing'''
----
 
1) Completed test cases for create 

:When test case was pending
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire'
end

:After writing test case
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire' do
tree_folder1 = double('TreeFolder')
allow(tree_folder1).to receive(:id).and_return(1)
allow(tree_folder1).to receive(:node_object_id).and_return(1)
tree_folder2 = double('TreeFolder')
allow(tree_folder2).to receive(:id).and_return(1)
allow(tree_folder2).to receive(:node_object_id).and_return(1)
allow(TreeFolder).to receive(:where).with(["name like ?", "Review"]).and_return([tree_folder1, tree_folder2])
folder_node2 = double('FolderNode')
allow(folder_node2).to receive(:id).and_return(1)
allow(FolderNode).to receive(:find_by_node_object_id).and_return(folder_node2)
user = double("User")
allow(user).to receive(:id).and_return(1)
params = {
questionnaire: {
private: "true",
type: "ReviewQuestionnaire",
name: "Random Name",
min_question_score: "0",
max_question_score: "5"
}
}
session = {user: user}
get :create, params, session
expect(flash[:success]).to eq("You have successfully created a questionnaire!")
response.should redirect_to(edit_questionnaire_path(id: 1))
end
end

2) Completed test cases for update_quiz 

:When test case was pending

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page'
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page'
# params = {
# id: 1,
# pid: 1,
# save: true,
# questionnaire: {
# name: 'test questionnaire',
# instructor_id: 6,
# private: 0,
# min_question_score: 0,
# max_question_score: 5,
# type: 'ReviewQuestionnaire',
# display_type: 'Review',
# instructor_loc: ''
# },
# question: {
# '1' => {txt: 'Q1'},
# '2' => {txt: 'Q2'},
# '3' => {txt: 'Q3'}
# },
# quiz_question_choices: {
# '1' => {MultipleChoiceRadio:
# {:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
# '2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
# '3' => {MultipleChoiceCheckbox:
# {'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
# '3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
# }
# }
end
end

:After writing test case

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page' do
params = {
id: 1,
pid: 1
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page' do
params = {
id: 3,
pid: 1,
save: true,
questionnaire: {
name: 'test questionnaire',
instructor_id: 6,
private: 0,
min_question_score: 0,
max_question_score: 5,
type: 'ReviewQuestionnaire',
display_type: 'Review',
instructor_loc: ''
},
question: {
'1' => {txt: 'Q1'},
'2' => {txt: 'Q2'},
'3' => {txt: 'Q3'}
},
quiz_question_choices: {
'1' => {MultipleChoiceRadio:
{:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
'2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
'3' => {MultipleChoiceCheckbox:
{'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
'3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
}
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end
end

'''Refactoring'''
----
 

*Create method has been split into two methods create and save_questionnaire_create

'''Before Modification:'''
def create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
begin
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

'''After Modification:'''

def create
begin
save_questionnaire_create
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

def save_questionnaire_create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
end

==Test Plan==
For testing methods, we don't have to check the preconditions, as we have been assigned with refactoring the methods and testing those refactored methods properly.

We check the file questionnaires_controller_spec.rb, and test the methods required to be refactored based on our modifications we have to carry out in the spec file for the testing methods.

{| class="wikitable"
|-
! Methods
! Contexts
|-
| view
| Properly checks the rendering of questionnaires
|-
| new
| Looks for system reaction to presence and absence of whitespace
|-
| create
| Checks if newly created page can be edited for values.
|-
| update_quiz
| Checks if the content in the questionnaire is nil or not
|-
| copy, copy_questionnaire_details, assign_instructor_id
| Tested the redirection to the view page of the copied questionnaire
|-

CSC/ECE 517 Fall 2017/E1749 TFD questionnaire controller.rb refactor

2017-11-02T05:48:10Z

Mmsatar2: /* Test Plan */

== About ==
Expertiza is a website that is used and developed by NCSU students and faculty. Coded using Ruby on Rails the source code is readily available on Github -> https://github.com/expertiza/expertiza. The website is used by students for organizing teams, signing up for topics, reviewing other teams and another bunch of tasks. The faculty i.e. Instructors and TAs use this website to set new tasks, add new questions and a few other tasks.

== Team Members ==

*Shreyas Zagade
*Mohit Satarkar
*Darshan Bhandari

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Files involved==

# questionnaire_controller.rb
# questionnaire_controller_spec.rb

==Issues==

:* questionnaires_controller.rb is a fairly complex file. 
:* It contains a lot of methods that are long and hard to understand, these methods need to be broken down into simpler and more specific methods that are easier to read/understand. 
:* Also, the few instances of code duplication that exist should be removed.

== Tasks assigned ==
# Complete pending tests in questionnaires_controller_spec.rb, and write integration tests for newly-created methods. Please finish one set of pending tests first before refactoring corresponding methods.
# Refactor create method
#* Write failing tests first
#* Split into several simpler methods and assign reasonable names
#* Extract duplicated code into separate methods
# Refactor update_quiz, save_choices method
#* Write failing tests first.
#* Use polymorphism to replace the long switch statements
#** Move if conditions to corresponding subclasses (eg. MultipleChoiceCheckbox.rb, MultipleChoiceRadio.rb) with same method name
#** Replace the conditional with the relevant method calls
#** Remove duplicated code
# Use find_by instead of dynamic method
#* Write failing tests first
#* L68, L385, L386, L559, L560

== Tasks Completed ==

*Testing
*Refactoring
 

'''Testing'''
----
 
1) Completed test cases for create 

:When test case was pending
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire'
end

:After writing test case
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire' do
tree_folder1 = double('TreeFolder')
allow(tree_folder1).to receive(:id).and_return(1)
allow(tree_folder1).to receive(:node_object_id).and_return(1)
tree_folder2 = double('TreeFolder')
allow(tree_folder2).to receive(:id).and_return(1)
allow(tree_folder2).to receive(:node_object_id).and_return(1)
allow(TreeFolder).to receive(:where).with(["name like ?", "Review"]).and_return([tree_folder1, tree_folder2])
folder_node2 = double('FolderNode')
allow(folder_node2).to receive(:id).and_return(1)
allow(FolderNode).to receive(:find_by_node_object_id).and_return(folder_node2)
user = double("User")
allow(user).to receive(:id).and_return(1)
params = {
questionnaire: {
private: "true",
type: "ReviewQuestionnaire",
name: "Random Name",
min_question_score: "0",
max_question_score: "5"
}
}
session = {user: user}
get :create, params, session
expect(flash[:success]).to eq("You have successfully created a questionnaire!")
response.should redirect_to(edit_questionnaire_path(id: 1))
end
end

2) Completed test cases for update_quiz 

:When test case was pending

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page'
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page'
# params = {
# id: 1,
# pid: 1,
# save: true,
# questionnaire: {
# name: 'test questionnaire',
# instructor_id: 6,
# private: 0,
# min_question_score: 0,
# max_question_score: 5,
# type: 'ReviewQuestionnaire',
# display_type: 'Review',
# instructor_loc: ''
# },
# question: {
# '1' => {txt: 'Q1'},
# '2' => {txt: 'Q2'},
# '3' => {txt: 'Q3'}
# },
# quiz_question_choices: {
# '1' => {MultipleChoiceRadio:
# {:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
# '2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
# '3' => {MultipleChoiceCheckbox:
# {'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
# '3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
# }
# }
end
end

:After writing test case

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page' do
params = {
id: 1,
pid: 1
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page' do
params = {
id: 3,
pid: 1,
save: true,
questionnaire: {
name: 'test questionnaire',
instructor_id: 6,
private: 0,
min_question_score: 0,
max_question_score: 5,
type: 'ReviewQuestionnaire',
display_type: 'Review',
instructor_loc: ''
},
question: {
'1' => {txt: 'Q1'},
'2' => {txt: 'Q2'},
'3' => {txt: 'Q3'}
},
quiz_question_choices: {
'1' => {MultipleChoiceRadio:
{:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
'2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
'3' => {MultipleChoiceCheckbox:
{'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
'3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
}
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end
end

'''Refactoring'''
----
 

*Create method has been split into two methods create and save_questionnaire_create

'''Before Modification:'''
def create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
begin
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

'''After Modification:'''

def create
begin
save_questionnaire_create
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

def save_questionnaire_create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
end

==Test Plan==
For testing methods, we don't have to check the preconditions, as we have been assigned with refactoring the methods and testing those refactored methods properly.

We check the file questionnaires_controller_spec.rb, and test the methods required to be refactored based on our modifications we have to carry out in the spec file for the testing methods.

{| class="wikitable"
|-
! Methods
! Contexts
|-
| view
| Properly checks the rendering of questionnaires
|-
| new
| Looks for presence and absence of whitespace, and how the system
| reacts to both contexts
|-
| create
| Checks if newly created page can be edited for values.
|-
| update_quiz
| Checks both the contexts if the content in the questionnaire is nil
| or not
|-
| copy, copy_questionnaire_details, assign_instructor_id
| Tested the redirection to the view page of the copied questionnaire
|-

CSC/ECE 517 Fall 2017/E1749 TFD questionnaire controller.rb refactor

2017-11-02T05:47:02Z

Mmsatar2: /* Test Plan */

== About ==
Expertiza is a website that is used and developed by NCSU students and faculty. Coded using Ruby on Rails the source code is readily available on Github -> https://github.com/expertiza/expertiza. The website is used by students for organizing teams, signing up for topics, reviewing other teams and another bunch of tasks. The faculty i.e. Instructors and TAs use this website to set new tasks, add new questions and a few other tasks.

== Team Members ==

*Shreyas Zagade
*Mohit Satarkar
*Darshan Bhandari

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Files involved==

# questionnaire_controller.rb
# questionnaire_controller_spec.rb

==Issues==

:* questionnaires_controller.rb is a fairly complex file. 
:* It contains a lot of methods that are long and hard to understand, these methods need to be broken down into simpler and more specific methods that are easier to read/understand. 
:* Also, the few instances of code duplication that exist should be removed.

== Tasks assigned ==
# Complete pending tests in questionnaires_controller_spec.rb, and write integration tests for newly-created methods. Please finish one set of pending tests first before refactoring corresponding methods.
# Refactor create method
#* Write failing tests first
#* Split into several simpler methods and assign reasonable names
#* Extract duplicated code into separate methods
# Refactor update_quiz, save_choices method
#* Write failing tests first.
#* Use polymorphism to replace the long switch statements
#** Move if conditions to corresponding subclasses (eg. MultipleChoiceCheckbox.rb, MultipleChoiceRadio.rb) with same method name
#** Replace the conditional with the relevant method calls
#** Remove duplicated code
# Use find_by instead of dynamic method
#* Write failing tests first
#* L68, L385, L386, L559, L560

== Tasks Completed ==

*Testing
*Refactoring
 

'''Testing'''
----
 
1) Completed test cases for create 

:When test case was pending
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire'
end

:After writing test case
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire' do
tree_folder1 = double('TreeFolder')
allow(tree_folder1).to receive(:id).and_return(1)
allow(tree_folder1).to receive(:node_object_id).and_return(1)
tree_folder2 = double('TreeFolder')
allow(tree_folder2).to receive(:id).and_return(1)
allow(tree_folder2).to receive(:node_object_id).and_return(1)
allow(TreeFolder).to receive(:where).with(["name like ?", "Review"]).and_return([tree_folder1, tree_folder2])
folder_node2 = double('FolderNode')
allow(folder_node2).to receive(:id).and_return(1)
allow(FolderNode).to receive(:find_by_node_object_id).and_return(folder_node2)
user = double("User")
allow(user).to receive(:id).and_return(1)
params = {
questionnaire: {
private: "true",
type: "ReviewQuestionnaire",
name: "Random Name",
min_question_score: "0",
max_question_score: "5"
}
}
session = {user: user}
get :create, params, session
expect(flash[:success]).to eq("You have successfully created a questionnaire!")
response.should redirect_to(edit_questionnaire_path(id: 1))
end
end

2) Completed test cases for update_quiz 

:When test case was pending

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page'
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page'
# params = {
# id: 1,
# pid: 1,
# save: true,
# questionnaire: {
# name: 'test questionnaire',
# instructor_id: 6,
# private: 0,
# min_question_score: 0,
# max_question_score: 5,
# type: 'ReviewQuestionnaire',
# display_type: 'Review',
# instructor_loc: ''
# },
# question: {
# '1' => {txt: 'Q1'},
# '2' => {txt: 'Q2'},
# '3' => {txt: 'Q3'}
# },
# quiz_question_choices: {
# '1' => {MultipleChoiceRadio:
# {:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
# '2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
# '3' => {MultipleChoiceCheckbox:
# {'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
# '3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
# }
# }
end
end

:After writing test case

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page' do
params = {
id: 1,
pid: 1
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page' do
params = {
id: 3,
pid: 1,
save: true,
questionnaire: {
name: 'test questionnaire',
instructor_id: 6,
private: 0,
min_question_score: 0,
max_question_score: 5,
type: 'ReviewQuestionnaire',
display_type: 'Review',
instructor_loc: ''
},
question: {
'1' => {txt: 'Q1'},
'2' => {txt: 'Q2'},
'3' => {txt: 'Q3'}
},
quiz_question_choices: {
'1' => {MultipleChoiceRadio:
{:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
'2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
'3' => {MultipleChoiceCheckbox:
{'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
'3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
}
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end
end

'''Refactoring'''
----
 

*Create method has been split into two methods create and save_questionnaire_create

'''Before Modification:'''
def create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
begin
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

'''After Modification:'''

def create
begin
save_questionnaire_create
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

def save_questionnaire_create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
end

==Test Plan==
For testing methods, we don't have to check the preconditions, as we have been assigned with refactoring the methods and testing those refactored methods properly.

We check the file questionnaires_controller_spec.rb, and test the methods required to be refactored based on our modifications we have to carry out in the spec file for the testing methods.

{| class="wikitable"
|-
! Methods
! Contexts
|-
| view
| Properly checks the rendering of questionnaires
|-
| new
| Looks for presence and absence of whitespace, and how the system
|reacts to both contexts
|-
| create
| Checks if newly created page can be edited for values.
|-
| update_quiz
| Checks both the contexts if the content in the questionnaire is nil
|or not
|-
| copy, copy_questionnaire_details, assign_instructor_id
| Tested the redirection to the view page of the copied questionnaire
|-

CSC/ECE 517 Fall 2017/E1749 TFD questionnaire controller.rb refactor

2017-11-02T05:46:16Z

Mmsatar2: /* Test Plan */

== About ==
Expertiza is a website that is used and developed by NCSU students and faculty. Coded using Ruby on Rails the source code is readily available on Github -> https://github.com/expertiza/expertiza. The website is used by students for organizing teams, signing up for topics, reviewing other teams and another bunch of tasks. The faculty i.e. Instructors and TAs use this website to set new tasks, add new questions and a few other tasks.

== Team Members ==

*Shreyas Zagade
*Mohit Satarkar
*Darshan Bhandari

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Files involved==

# questionnaire_controller.rb
# questionnaire_controller_spec.rb

==Issues==

:* questionnaires_controller.rb is a fairly complex file. 
:* It contains a lot of methods that are long and hard to understand, these methods need to be broken down into simpler and more specific methods that are easier to read/understand. 
:* Also, the few instances of code duplication that exist should be removed.

== Tasks assigned ==
# Complete pending tests in questionnaires_controller_spec.rb, and write integration tests for newly-created methods. Please finish one set of pending tests first before refactoring corresponding methods.
# Refactor create method
#* Write failing tests first
#* Split into several simpler methods and assign reasonable names
#* Extract duplicated code into separate methods
# Refactor update_quiz, save_choices method
#* Write failing tests first.
#* Use polymorphism to replace the long switch statements
#** Move if conditions to corresponding subclasses (eg. MultipleChoiceCheckbox.rb, MultipleChoiceRadio.rb) with same method name
#** Replace the conditional with the relevant method calls
#** Remove duplicated code
# Use find_by instead of dynamic method
#* Write failing tests first
#* L68, L385, L386, L559, L560

== Tasks Completed ==

*Testing
*Refactoring
 

'''Testing'''
----
 
1) Completed test cases for create 

:When test case was pending
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire'
end

:After writing test case
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire' do
tree_folder1 = double('TreeFolder')
allow(tree_folder1).to receive(:id).and_return(1)
allow(tree_folder1).to receive(:node_object_id).and_return(1)
tree_folder2 = double('TreeFolder')
allow(tree_folder2).to receive(:id).and_return(1)
allow(tree_folder2).to receive(:node_object_id).and_return(1)
allow(TreeFolder).to receive(:where).with(["name like ?", "Review"]).and_return([tree_folder1, tree_folder2])
folder_node2 = double('FolderNode')
allow(folder_node2).to receive(:id).and_return(1)
allow(FolderNode).to receive(:find_by_node_object_id).and_return(folder_node2)
user = double("User")
allow(user).to receive(:id).and_return(1)
params = {
questionnaire: {
private: "true",
type: "ReviewQuestionnaire",
name: "Random Name",
min_question_score: "0",
max_question_score: "5"
}
}
session = {user: user}
get :create, params, session
expect(flash[:success]).to eq("You have successfully created a questionnaire!")
response.should redirect_to(edit_questionnaire_path(id: 1))
end
end

2) Completed test cases for update_quiz 

:When test case was pending

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page'
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page'
# params = {
# id: 1,
# pid: 1,
# save: true,
# questionnaire: {
# name: 'test questionnaire',
# instructor_id: 6,
# private: 0,
# min_question_score: 0,
# max_question_score: 5,
# type: 'ReviewQuestionnaire',
# display_type: 'Review',
# instructor_loc: ''
# },
# question: {
# '1' => {txt: 'Q1'},
# '2' => {txt: 'Q2'},
# '3' => {txt: 'Q3'}
# },
# quiz_question_choices: {
# '1' => {MultipleChoiceRadio:
# {:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
# '2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
# '3' => {MultipleChoiceCheckbox:
# {'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
# '3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
# }
# }
end
end

:After writing test case

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page' do
params = {
id: 1,
pid: 1
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page' do
params = {
id: 3,
pid: 1,
save: true,
questionnaire: {
name: 'test questionnaire',
instructor_id: 6,
private: 0,
min_question_score: 0,
max_question_score: 5,
type: 'ReviewQuestionnaire',
display_type: 'Review',
instructor_loc: ''
},
question: {
'1' => {txt: 'Q1'},
'2' => {txt: 'Q2'},
'3' => {txt: 'Q3'}
},
quiz_question_choices: {
'1' => {MultipleChoiceRadio:
{:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
'2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
'3' => {MultipleChoiceCheckbox:
{'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
'3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
}
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end
end

'''Refactoring'''
----
 

*Create method has been split into two methods create and save_questionnaire_create

'''Before Modification:'''
def create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
begin
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

'''After Modification:'''

def create
begin
save_questionnaire_create
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

def save_questionnaire_create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
end

==Test Plan==
For testing methods, we don't have to check the preconditions, as we have been assigned with refactoring the methods and testing those refactored methods properly.

We check the file questionnaires_controller_spec.rb, and test the methods required to be refactored based on our modifications we have to carry out in the spec file for the testing methods.

{| class="wikitable"
|-
! Methods
! Contexts
|-
| view
| Properly checks the rendering of questionnaires
|-
| new
| Looks for presence and absence of whitespace, and how the system
reacts to both contexts
|-
| create
| Checks if newly created page can be edited for values.
|-
| update_quiz
| Checks both the contexts if the content in the questionnaire is nil
or not
|-
| copy, copy_questionnaire_details, assign_instructor_id
| Tested the redirection to the view page of the copied questionnaire
|-

CSC/ECE 517 Fall 2017/E1749 TFD questionnaire controller.rb refactor

2017-11-02T04:36:42Z

Mmsatar2:

== About ==
Expertiza is a website that is used and developed by NCSU students and faculty. Coded using Ruby on Rails the source code is readily available on Github -> https://github.com/expertiza/expertiza. The website is used by students for organizing teams, signing up for topics, reviewing other teams and another bunch of tasks. The faculty i.e. Instructors and TAs use this website to set new tasks, add new questions and a few other tasks.

== Team Members ==

*Shreyas Zagade
*Mohit Satarkar
*Darshan Bhandari

== Setting Up The Working Environment ==
''One of several ways to set up the environment and the one we adopted is:-'' 
'''Ubuntu-Expertiza image (.OVA) [Recommended]''' 
:This is the link for the image. (https://drive.google.com/a/ncsu.edu/file/d/0B2vDvVjH76uEUmNKVncxRUhUVVE/view?usp=sharing) 
:And you can install VirtualBox (free) and import this image into VirtualBox. 
'''Some machine may require you to enable virtualization and then run the following commands.''' 
<pre>cd expertiza </pre>
<pre>bash ./setup.sh </pre>
<pre>bundle install </pre>
<pre>rake db:migrate </pre>
*For logging in as an instructor:- 
:Username: instructor6 
:Password: password 

== Files involved==

# questionnaire_controller.rb
# questionnaire_controller_spec.rb

==Issues==

:* questionnaires_controller.rb is a fairly complex file. 
:* It contains a lot of methods that are long and hard to understand, these methods need to be broken down into simpler and more specific methods that are easier to read/understand. 
:* Also, the few instances of code duplication that exist should be removed.

== Tasks assigned ==
# Complete pending tests in questionnaires_controller_spec.rb, and write integration tests for newly-created methods. Please finish one set of pending tests first before refactoring corresponding methods.
# Refactor create method
#* Write failing tests first
#* Split into several simpler methods and assign reasonable names
#* Extract duplicated code into separate methods
# Refactor update_quiz, save_choices method
#* Write failing tests first.
#* Use polymorphism to replace the long switch statements
#** Move if conditions to corresponding subclasses (eg. MultipleChoiceCheckbox.rb, MultipleChoiceRadio.rb) with same method name
#** Replace the conditional with the relevant method calls
#** Remove duplicated code
# Use find_by instead of dynamic method
#* Write failing tests first
#* L68, L385, L386, L559, L560

== Tasks Completed ==

*Testing
*Refactoring
 

'''Testing'''
----
 
1) Completed test cases for create 

:When test case was pending
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire'
end

:After writing test case
describe '#create' do
it 'redirects to questionnaires#edit page after create a new questionnaire' do
tree_folder1 = double('TreeFolder')
allow(tree_folder1).to receive(:id).and_return(1)
allow(tree_folder1).to receive(:node_object_id).and_return(1)
tree_folder2 = double('TreeFolder')
allow(tree_folder2).to receive(:id).and_return(1)
allow(tree_folder2).to receive(:node_object_id).and_return(1)
allow(TreeFolder).to receive(:where).with(["name like ?", "Review"]).and_return([tree_folder1, tree_folder2])
folder_node2 = double('FolderNode')
allow(folder_node2).to receive(:id).and_return(1)
allow(FolderNode).to receive(:find_by_node_object_id).and_return(folder_node2)
user = double("User")
allow(user).to receive(:id).and_return(1)
params = {
questionnaire: {
private: "true",
type: "ReviewQuestionnaire",
name: "Random Name",
min_question_score: "0",
max_question_score: "5"
}
}
session = {user: user}
get :create, params, session
expect(flash[:success]).to eq("You have successfully created a questionnaire!")
response.should redirect_to(edit_questionnaire_path(id: 1))
end
end

2) Completed test cases for update_quiz 

:When test case was pending

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page'
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page'
# params = {
# id: 1,
# pid: 1,
# save: true,
# questionnaire: {
# name: 'test questionnaire',
# instructor_id: 6,
# private: 0,
# min_question_score: 0,
# max_question_score: 5,
# type: 'ReviewQuestionnaire',
# display_type: 'Review',
# instructor_loc: ''
# },
# question: {
# '1' => {txt: 'Q1'},
# '2' => {txt: 'Q2'},
# '3' => {txt: 'Q3'}
# },
# quiz_question_choices: {
# '1' => {MultipleChoiceRadio:
# {:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
# '2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
# '3' => {MultipleChoiceCheckbox:
# {'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
# '3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
# }
# }
end
end

:After writing test case

describe '#update_quiz' do
context 'when @questionnaire is nil' do
it 'redirects to submitted_content#view page' do
params = {
id: 1,
pid: 1
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end

context 'when @questionnaire is not nil' do
it 'updates all quiz questions and redirects to submitted_content#view page' do
params = {
id: 3,
pid: 1,
save: true,
questionnaire: {
name: 'test questionnaire',
instructor_id: 6,
private: 0,
min_question_score: 0,
max_question_score: 5,
type: 'ReviewQuestionnaire',
display_type: 'Review',
instructor_loc: ''
},
question: {
'1' => {txt: 'Q1'},
'2' => {txt: 'Q2'},
'3' => {txt: 'Q3'}
},
quiz_question_choices: {
'1' => {MultipleChoiceRadio:
{:correctindex => 1, '1' => {txt: 'a11'}, '2' => {txt: 'a12'}, '3' => {txt: 'a13'}, '4' => {txt: 'a14'}}},
'2' => {TrueFalse: {'1' => {iscorrect: 'True'}}},
'3' => {MultipleChoiceCheckbox:
{'1' => {iscorrect: '1', txt: 'a31'}, '2' => {iscorrect: '0', txt: 'a32'},
'3' => {iscorrect: '1', txt: 'a33'}, '4' => {iscorrect: '0', txt: 'a34'}}}
}
}
get :update_quiz, params
response.should redirect_to(view_submitted_content_index_path(id: params[:pid]))
end
end
end

'''Refactoring'''
----
 

*Create method has been split into two methods create and save_questionnaire_create

'''Before Modification:'''
def create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
begin
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

'''After Modification:'''

def create
begin
save_questionnaire_create
# Create node
tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first
parent = FolderNode.find_by_node_object_id(tree_folder.id)
QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')
flash[:success] = 'You have successfully created a questionnaire!'
rescue
flash[:error] = $ERROR_INFO
end
redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id
end

def save_questionnaire_create
questionnaire_private = params[:questionnaire][:private] == "true" ? true : false
display_type = params[:questionnaire][:type].split('Questionnaire')[0]
if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]
@questionnaire = Object.const_get(params[:questionnaire][:type]).new
end
@questionnaire.private = questionnaire_private
@questionnaire.name = params[:questionnaire][:name]
@questionnaire.instructor_id = session[:user].id
@questionnaire.min_question_score = params[:questionnaire][:min_question_score]
@questionnaire.max_question_score = params[:questionnaire][:max_question_score]
@questionnaire.type = params[:questionnaire][:type]
# Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.
# In the future, we need to write migration files to make them consistency.
case display_type
when 'AuthorFeedback'
display_type = 'Author%Feedback'
when 'CourseSurvey'
display_type = 'Course%Survey'
when 'TeammateReview'
display_type = 'Teammate%Review'
when 'GlobalSurvey'
display_type = 'Global%Survey'
when 'AssignmentSurvey'
display_type = 'Assignment%Survey'
end
@questionnaire.display_type = display_type
@questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL
@questionnaire.save
end

==Test Plan==
The pre conditions which are required to test the methods are not applicable because the project includes the process of refactoring and testing the refactored methods.

The response_spec.rb file does not include any edge cases. The edge cases are out of scope because the project includes refactoring and writing test cases.

{| class="wikitable"
|-
! Methods
! Contexts
|-
| response_id
| tests if the response id is returned
|-
| display_as_html
| tests if corresponding html page is rendered based on the id passed
|-
| construct_instructor_html
| not tested
|-
| construct_student_html
| not tested
|-
| construct_review_response
| not tested
|-
| add_table_rows
|
|-
| additional_comment
|
|-
| total_score
| tests if the method computes the total score of the review
|-
| delete
|
|-
| average_score
| tests if the method computes the average score when the other function computes the maximum score
|-
| maximum_score
| tests if the method returns the maximum score of the current review
|-
| email
| tests if there is a call to email method in corresponding response maps
|-
| questionnaire_by_answer
| tests if method returns the questionnaire of the question of current answer or review questionnaire of current assignment based on the value of the answer
|-
| concatenate_all_review_comments
| tests if the method returns concatenated review comments
|-
| get_volume_of_review_comments
| tests if the method returns volumes of review comments in each round
|-
| significant_difference?
| tests if the method returns true when the difference between average score on same artifact from others and current score is bigger than allowed percentage otherwise false
|-
| avg_scores_and_count_for_prev_reviews
| tests if the method returns the average score and count of previous reviews when current response is not in current response array
|-
| notify_instructor_on_difference
|
|}