Expertiza_Wiki - User contributions [en]

File:Pie chart.png

2019-12-07T01:38:51Z

Sjrathi: uploaded a new version of "File:Pie chart.png"

Pie Chart that the instructor views.

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-12-07T01:31:01Z

Sjrathi: /* Our Work */

== ''' Introduction ''' ==
The [http://expertiza.ncsu.edu/ Expertiza] project takes advantage of peer-review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resources is meaningful to instructors to study and improve the teaching experience. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission (e.g. GitHub code / deployed application), which makes it difficult for the system to track the time that the reviewers spend on the submissions.

== ''' Problem Statement ''' ==
Knowing how much time a student spends on a review is helpful when determining the quality of the review itself. That being said Expertiza needs to be able to '''track''' and '''display''' how much time a student spends on each review.

The time spent on a review is the sum of multiple sources:

# The time spent on the Expertiza assignment review page itself
# The time spent looking at external pages linked from the review page
# The time spent looking at downloadable files submitted by other students

The purpose of this project three-fold:

# Gather the timing data from the sources above.
# Display the data on the "Review Report" page (views/review_mapping/_review_report.html.erb) to show the time the student spent per review. Given that previous attempts have been rejected due to UI issues, it is important that this data is displayed cleanly.
# Write tests that confirm that the above goals are functioning correctly.

=== Current Implementation ===
So far, Expertiza does not have any such feature. However, three teams have already worked on this in the past but their builds were not merged due to some problems.
#[https://github.com/expertiza/expertiza/pull/875 E1705] identified how to track the active time of windows opened from the submitted links. ([http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2016/E1705._Tracking_the_time_students_look_at_the_others%27_submissions Wiki])
#[https://github.com/expertiza/expertiza/pull/1124 E1791] provided detailed insights on how they planned to track time taken by a student in viewing a submission and possible edge cases. Further, they also implemented popups and figured out a way to open downloadable files. However, the details are rendered in a not-so-friendly manner and hence it was not merged. ([http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E1791._Track_the_time_that_students_look_at_the_other_submissions_-_logging_improvement Wiki])
#[https://github.com/expertiza/expertiza/pull/1309 E1872] tried to solve this by incorporating the statistics in the review reports page, but their UI made the page cluttered and not friendly. Further, it was hard to identify which statistic belonged to which review, and there were almost no tests. ([http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1872_Track_Time_Students_Look_At_Other_Submissions Wiki])

== ''' Proposed Solution ''' ==
After investigating the prior attempts at this task, we have decided it would be best to begin our project by building off of the work done in project [https://github.com/expertiza/expertiza/pull/1124 E1791]. The reason for choosing to build off of this particular project is because they have already put the work into tracking time spent viewing external pages as well as time spent viewing certain types of downloadable files. In order to achieve our goals outlined in the [[#Problem Statement|Problem Statement]] section, the following changes need to be made:

; The time spent on the Expertiza assignment review page needs to be tracked.
*This will be done by using onFocus and onBlur mouse events to tell when a user is actively working on the page.
*To prevent the user from cheating the system by just keeping the review page open without doing work, a timeout feature will be implemented. After 5 minutes of mouse/keyboard inactivity, a popup will be displayed asking if the user is still working. At that point, the time contributed towards the total by the Expertiza page will stop being tracked until the user interacts with the popup to indicate they are still working. This is already implemented in project [https://github.com/expertiza/expertiza/pull/1124 E1791].

; The time spent viewing the external links and downloadable files will need to be made more accurate.
*Currently, if a student has an external link open as well as the Expertiza page, time is being tracked for both. Changes need to be made so that when the student is working on the Expertiza assignment review page time is not tracked for the external links or downloadable files.

; The overall time spent on the review needs to be displayed in a table on the "Review Report" page.
*The table will look like the following table, but with one modification. The entries in "Time per review in mins" will be clickable. When clicked, they will display a popup that contains detailed information on where the time for the review was spent. For example, if a student spent a total of 22 minutes on the review, it will show that the student spent 5 minutes on the Expertiza review page, 10 minutes looking at external links, and 7 minutes looking at downloadable files. It will display these details in text format as well as graphically using a bar graph. The purpose of choosing this design is two-fold:
# It will not require the instructor to have to go to a different page every time they want more details on a particular review. Given that the review report page takes a substantial time to load, this is a necessity.
# It will prevent the table on the review report page from being cluttered by figures and too much data.

[[File:Review report view.png]]

=== Design pattern ===
'''Strategy:''' In this project, for each review page, we need to deal with different type of links. For online links, such as github repo, youtube link, etc, we use javascript to open a new window detect time when the window is closed. For submitted files, such as txt, jpg, we will open it with views/response/_submitted_files.html.erb. For other files that need to be download and open locally, we can only make approximation for review time.

=== ''' Flowchart ''' ===

Reviewer 
Every time a start time is logged for expertiza/link/file, a new entry will be created in the database.End time will be updated on the last entry present for the same link/file.
[[File:E1989_Student_flowchart.png | center]]
 
Instructor 
Time for individual links will summed and then displayed as bar graph.
[[File:E1989_Instructor_flowchart.png | center]]

== ''' Code Changes ''' ==
1. Created a controller to handle the start/end times of the files viewed by the user. => '''controllers/submission_viewing_events_controller.rb''' 

2. Created a table in database to log start and end time for each link/file. It's schema is described below. 
{| class="wikitable"
|+ Schema for table submission_viewing_events
|-
! Field
! Type
! Null
! Key
|-
| id
| int(11)
| NO
| Primary Key
|-
| map_id
| int(11)
| YES
|
|-
| round
| int(11)
| YES
|
|-
| link
| varchar(255)
| YES
|
|-
| start_at
| datetime
| YES
|
|-
| end_at
| datetime
| YES
|
|-
| created_at
| datetime
| NO
|
|-
| updated_at
| datetime
| NO
|
|}
3. Added view that will display with pie chart when instructor wants to see time spent on individual links/files. 
[[File:Pie chart.png]]

=== ''' Files that have been Added or Changed ''' ===
'''submission_viewing_events_controller.rb '''
The <tt>record_start_time</tt> function starts the time for links that have been visited by the user.
<pre>
def record_start_time
param_args = params[:submission_viewing_event]
# check if this link is already opened and timed
submission_viewing_event_records = SubmissionViewingEvent.where(map_id: param_args[:map_id], round: param_args[:round], link: param_args[:link])
# if opened, end these records with current time
if submission_viewing_event_records
submission_viewing_event_records.each do |time_record|
if time_record.end_at.nil?
# time_record.update_attribute('end_at', start_at)
time_record.destroy
end
end
end
# create new response time record for current link
submission_viewing_event = SubmissionViewingEvent.new(submission_viewing_event_params)
submission_viewing_event.save

#if creating start time for expertiza update end times for all other links.
if param_args[:link]=='Expertiza Review'
params[:submission_viewing_event][:link] = nil
params[:submission_viewing_event][:end_at] = params[:submission_viewing_event][:start_at]
record_end_time()
end
render nothing: true
end
</pre>
 The <tt>record_end_time</tt> function records the end time for links that have been visited by the user.
<pre>
def record_end_time
data = params.require(:submission_viewing_event)
if data[:link].nil?
submission_viewing_event_records = SubmissionViewingEvent.where(map_id: data[:map_id], round: data[:round], end_at: nil).where.not(link: "Expertiza Review")
else
submission_viewing_event_records = SubmissionViewingEvent.where(map_id: data[:map_id], round: data[:round], link: data[:link])
end
submission_viewing_event_records.each do |time_record|
if time_record.end_at.nil?
time_record.update_attribute('end_at', data[:end_at])
# break
end
end
respond_to do |format|
format.json { head :no_content }
end
end
</pre>
 The <tt>mark_end_time</tt> function records the end time for links that have no end times.
<pre>
def mark_end_time
data = params.require(:submission_viewing_event)
@link_array = []
submission_viewing_event_records = SubmissionViewingEvent.where(map_id: data[:map_id], round: data[:round])
submission_viewing_event_records.each do |submissionviewingevent_entry|
if submissionviewingevent_entry.end_at.nil?
@link_array.push(submissionviewingevent_entry.link)
submissionviewingevent_entry.update_attribute('end_at', data[:end_at])
end
end
respond_to do |format|
format.json { render json: @link_array }
end
end
</pre>

reviewer_details_popup.html.erb 
_review_report.html.erb 
_review_submissions_time_spent.html.erb 
response_times.coffee 
response_times.scss 
response_controller.rb 
response_times_controller.rb 
responses_times_helper.rb 
review_mapping_helper.rb 
response_time.rb 
_submitted_files.html.erb

=== ''' Algorithm For Precise Timing Accuracy ''' ===
Previous implementations attempted to record the time users spent viewing each link, but their solution has multiple problems. The primary problem was that when multiple links were open at the same time (thus overlapping with one another) the times at which they overlap are recorded twice. To fix this, we implemented the following algorithm within \app\views\reports\_review_submissions_time_spent.html.erb:

<pre>
Consider that each link duration (the amount of time that link is being looked at) has a starting and ending edge (see diagram below). These durations are stored in an array durations_to_consider.

Iterate through every link duration in durations_to_consider:
If any other link's start and end times both fit within our start and end time:
Remove from durations_to_consider

For list of durations_to_consider, add those durations' start and end edges to edge_array.

Ensure that entries in edge_array are sorted from earliest to latest.

Create list duration_sections.

Start at the first edge in edge_array. Go until next edge. Record the time difference as a duration and add time to duration_sections.

If, after we add an edge that corresponds to the ending edge of a link duration, there are no open start edges (a start edge that belongs to a link, that does not yet have an accompanying end edge that belongs to that link):
Count the NEXT start edge as the start edge of the next duration section. This will prevent empty space caused by no link being open at that time from being counted towards the total.

Total up the time for all durations to get the total amount of time spent on links.
</pre>

'''NOTE:''' The following diagrams are simply meant to help explain the timing algorithm. They are not indicative of the real system. For example, there will never be a time when an Expertiza duration overlaps with a link duration.

The following diagram shows an example of what links could look like prior to our algorithm running:
[[File:Final_documentation_before_algorithm.PNG | center]]

After our algorithm runs, one can see that the overlapping segments are eliminated. For convenience, each duration_section is highlighted:
[[File:Final_documentation_after_algorithm.PNG | center]]

== ''' Test Plan ''' ==
=== Automated Testing Using RSpec ===
We have made changes to the controllers/submission_viewing_events_controller.rb and added test cases for the same, which have passed all the test cases. The tests can be executed <tt>rpec spec</tt> and the results for the files we have modified are shown below:

<pre>
Randomized with seed 20933
.....

Finished in 10.31 seconds (files took 7.85 seconds to load)
5 examples, 0 failures
</pre>

=== Manual UI Testing ===
We hope to not need any manual UI testing, though if it is needed, it'll look something like this:

Verifying Time is Tracked Correctly:
# Sign in as as a student
# Review an assignment
# Go through the review as normal
## Make sure you open links to github or pull requests
## Make sure you download and/or view files that are attatched
# Submit your review when you're done
# Log out as a student
# Log in as an instructor
# Navigate to the review report tab
# You should see a new column detailing the time the user spent on the review.

== ''' Our Work ''' ==
The code we created can be found below.
*[https://github.com/rohanpillai20/expertiza GitHub Repository]
*[https://github.com/expertiza/expertiza/pull/1607 Pull Request]
*[http://152.46.18.99:8080/ Deployed Link]
*[http://www.youtube.com/ YouTube Video] (To be updated.)

The project could be run locally by cloning the [https://github.com/rohanpillai20/expertiza GitHub Repository] and then running the following commands sequentially.

<pre>
bundle install
rake db:create:all
rake db:migrate
rails s
</pre>

== ''' Issues found and fixes ''' ==
#If a student only saves the review and does not submit it before the due date, the response exists but the entry is not updated as submitted. Because of this the response entry is not updated with the end time and hence when we try to calculate the total response object time, it calculates that as zero and hence shows "Review hasn't been submitted". The response table should be updated once it's past due date. This was out of scope for this project hence we leave it as future fix.
#The "Save review after every 60 seconds" checkbox does not work correctly, hence we defaulted that to unchecked as opposed to previous implementation where it was checked, because it hampers with our implementation. This is another fix required.
#The submission_viewing_event table increases in size very rapidly as it stores start and end times for each link if a particular event occurs. Solution to that would be to save all the entries locally in users system and update the database only with expertiza time and link time after performing the time calculation, once the user clicks Save/Submit. This would prevent the database from saving unnecessary amount of information and also make it work faster.

== ''' Team Information ''' ==
#Dylan Spruill (drspruil)
#Forrest Devita (fcdevita)
#Rohan Pillai (rspillai)
#Shalin Rathi (sjrathi)

Mentor: Akanksha Mohan (amohan7)
 Professor: Dr. Edward F. Gehringer (efg)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-16T04:48:51Z

Sjrathi: /* Files that will be Added or Changed */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-14T01:36:19Z

Sjrathi: /* Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-14T01:35:43Z

Sjrathi: /* Anticipated Code Changes */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-14T01:35:28Z

Sjrathi: /* Anticipated Code Changes */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-13T04:17:47Z

Sjrathi: /* Design pattern */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-13T04:17:33Z

Sjrathi: /* Proposed Solution */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-13T03:04:09Z

Sjrathi: /* Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-13T03:03:08Z

Sjrathi: /* Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-13T02:26:14Z

Sjrathi: /* Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-13T02:25:54Z

Sjrathi: /* Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-13T02:25:11Z

Sjrathi: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-12T18:26:46Z

Sjrathi: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-12T18:26:37Z

Sjrathi: /* Introduction */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T09:08:51Z

Sjrathi: /* User Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T09:07:09Z

Sjrathi: /* User Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T09:06:34Z

Sjrathi: /* User Flowchart */

File:E1989 Instructor flowchart.png

2019-11-11T09:05:48Z

Sjrathi: uploaded a new version of "File:E1989 Instructor flowchart.png"

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T09:03:39Z

Sjrathi: /* User Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T09:03:00Z

Sjrathi: /* User Flowchart */

File:E1989 Student flowchart.png

2019-11-11T08:59:45Z

Sjrathi: uploaded a new version of "File:E1989 Student flowchart.png"

File:E1989 Instructor flowchart.png

2019-11-11T08:59:07Z

Sjrathi: uploaded a new version of "File:E1989 Instructor flowchart.png"

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T06:06:28Z

Sjrathi: /* Proposed Solution */

File:E1989 Student flowchart.png

2019-11-11T06:03:02Z

Sjrathi:

File:E1989 Instructor flowchart.png

2019-11-11T06:02:30Z

Sjrathi:

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T06:01:40Z

Sjrathi: /* Proposed Solution */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T05:59:17Z

Sjrathi: /* User Flowchart */

File:Instructor.png

2019-11-11T05:58:55Z

Sjrathi: uploaded a new version of "File:Instructor.png"

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T05:57:02Z

Sjrathi: /* User Flowchart */

File:Instructor flowchart.png

2019-11-11T05:54:03Z

Sjrathi: uploaded a new version of "File:Instructor flowchart.png"

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T05:53:13Z

Sjrathi: /* User Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T05:52:42Z

Sjrathi: /* User Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T05:50:07Z

Sjrathi: /* User Flowchart */

File:Instructor flowchart.png

2019-11-11T05:48:54Z

Sjrathi: uploaded a new version of "File:Instructor flowchart.png": Reverted to version as of 22:55, 10 November 2019

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T05:48:33Z

Sjrathi: /* User Flowchart */

File:Instructor flowchart.png

2019-11-11T05:48:05Z

Sjrathi: uploaded a new version of "File:Instructor flowchart.png"

File:Student flowchart.png

2019-11-11T05:47:16Z

Sjrathi:

File:Instructor flowchart.png

2019-11-11T05:46:50Z

Sjrathi: uploaded a new version of "File:Instructor flowchart.png"

File:Instructor flowchart.png

2019-11-11T05:46:19Z

Sjrathi: uploaded a new version of "File:Instructor flowchart.png"

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-11T05:45:58Z

Sjrathi: /* User Flowchart */

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-10T22:56:50Z

Sjrathi: /* User Flowchart */

File:Instructor flowchart.png

2019-11-10T22:55:28Z

Sjrathi:

CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions

2019-11-10T22:54:57Z

Sjrathi: /* Proposed Solution */

CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz questionnaire controller.rb

2019-10-29T05:51:50Z

Sjrathi: /* Project Mentors */

==E1947. Refactoring quiz_questionnaire_controller.rb==

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

__TOC__

===About Expertiza===

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

===Problem Statement===
The following tasks were accomplished in this project:

* Rename filename such that it follows the coding standards
* Remove redundant information from method names
* Add comments to methods and complex lines of code
* Remove unsafe reflection method
* Simplify RSpec
* Try to fix issues from Code Climate

===About Quiz Questionnaire Controller===
This is a new controller, having recently been separated from questionnaires_controller.rb. It is used to allow students to take quizzes. The idea is that the author(s) of submitted work can write a quiz that is given to each reviewer before the reviewer is allowed to review the work. If the reviewer does badly on the quiz, then we know not to trust the review. It is also possible to set up an Expertiza assignment so that some participants just take the quiz and don’t review the work.

===Current Implementation===

=====Functionality=====
* A student can create a quiz questionnaire for the assignments that allow a quiz to be generated. This quiz will be taken by the reviewers, once they are done reviewing the development/project. Based on their answers the TA's can know whether to consider the reviewer's review or not based , because if the reviewer didn't perform well on the quiz, then it is likely that the review is not done properly.

* The maximum number of questions is decided by the instructor when creating the assignment.

* The student has option to either create True/False, Multiple-Choice Checkbox or Multiple-Choice Radio question.

* The question cannot be blank and correct answer must be selected to create a quiz.
 
=====Drawbacks and Solutions=====
* '''Problem 1''':Rename filename such that it follows the coding standards
'''Solution''':Currently the file was named as quiz_questionnaire_controller.rb. This doesn't follow the Ruby naming standards. Hence it was changed to quiz_questionnaires_controller.rb
* '''Problem 2''':Remove redundant information from method names
'''Solution''':Since this controller was separated from the questionnaires_controller.rb, the method names were kept the same from the previous controller which had redundant information.
Method names were renamed by removing the succeeding '_quiz'. Also valid_quiz was renamed to validate_quiz to make more sense. Also the routes.rb was changed to accept these changes.
* '''Problem 3''':Add comments to methods and complex lines of code
'''Solution''':Many methods had more than 325 lines of code and performed multiple functionalities. These methods were changed by creating private methods that performed individual tasks, thus reducing the lines of code and the complexity.
* '''Problem 4''':Remove unsafe reflection method
'''Solution''':This part was already implemented, hence no changes were made.
* '''Problem 5''':Try to fix issues from Code Climate
'''Solution''':Refer to Solution for Problem 3

===Code improvements===
* The method '''save_choices''' had a congnitive complexity of 23 and had 37 lines of code. By refactoring, the number of lines was reduced to 20 and private methods '''create_checkbox''', '''create_truefalse''' and '''create_radio''' were implemented to break up functionality and to reduce cognitive complexity.
'''Before:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
params[:new_choices][question_num.to_s][q_type].each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
q = if params[:new_choices][question_num.to_s][q_type][choice_key][:iscorrect] == 1.to_s
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
elsif q_type == "TrueFalse"
if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
q = QuizQuestionChoice.new(txt: "True", iscorrect: "true", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "false", question_id: question.id)
q.save
else
q = QuizQuestionChoice.new(txt: "True", iscorrect: "false", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "true", question_id: question.id)
q.save
end
else
q = if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
end
end
question_num += 1
question.weight = 1
end
end
</pre>
'''After:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
q_choices = params[:new_choices][question_num.to_s][q_type]
q_choices.each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
create_checkbox(question, choice_key, q_choices)
elsif q_type == "TrueFalse"
create_truefalse(question, choice_key, q_choices)
else # MultipleChoiceRadio
create_radio(question, choice_key, q_choices)
end
end
question_num += 1
question.weight = 1
end
end
</pre>

 
* The method '''action_allowed?''' has been implemented in quiz_questionnaire_controller.rb to specifically allow Student to edit an existing quiz.
 
* The quiz_questionnaire_controller_spec.rb has been updated to allow edit tests to work for Student role.
<pre>
let(:student) { build(:student, id: 8609) }
</pre>
'''Before:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''Before:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
 
* The method '''update_quiz''' has been renamed to '''update''' and has been refactored to reduce the line count by breaking functionalities. (The function '''multiple_choice_checkbox''' was renamed to '''update_checkbox''' and '''multiple_choice_radio''' was renamed to '''update_radio''' so as to reduce function name length and bring consistency with methods performing create operations: '''create_radio''', '''create_checkbox''', '''create_truefalse''')
The Cognitive Complexity of update method has now been reduced to 15 (from 29). 
'''Before:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
multiple_choice_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
multiple_choice_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
if @question.type == "TrueFalse"
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>

'''After:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)
params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save
@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
update_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
update_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
update_truefalse(question_choice) if @question.type == "TrueFalse"
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>
<pre>
def update_truefalse(question_choice)
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
</pre>

 
* The method '''valid_quiz''' has been renamed to '''validate_quiz'''. The function '''validate_question''' was extracted out to only validate the particular question. The part where quiz name was being verified was also taken out of the loop to only verify this once as opposed to verifying in each iteration, which was unnecessary. The Cognitive Complexity of 12 has now been reduced to less than 5.
'''Before:'''
<pre>
def valid_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"

(1..num_questions).each do |i|
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
elsif !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isnt selected for a question
valid = "Please select a type for each question"
else
@new_question = Object.const_get(params[:question_type][i.to_s][:type]).create(txt: '', type: params[:question_type][i.to_s][:type], break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
type = params[:question_type][i.to_s][:type]
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
break if valid != "valid"
end
valid
end
</pre>
'''After:'''
<pre>
def validate_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
end
(1..num_questions).each do |i|
break if valid != "valid"
valid = validate_question(i)
end
valid
end
</pre>
<pre>
def validate_question(i)
if !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isn't selected for a question
valid = "Please select a type for each question"
else
# The question type is dynamic, so const_get is necessary
type = params[:question_type][i.to_s][:type]
@new_question = Object.const_get(type).create(txt: '', type: type, break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
valid
end
</pre>

===Testing===
Link to [https://youtu.be/dVu0-LZcW1w video] showing the RSpec testing.
====Automated Testing using RSPEC====
[[File:RspecResults.png]]

====Testing from Travis CI====
[[File:TravisCIBuild.png]]
[[File:GitChecksPass.png]]

==Project Mentors==

#Edward Gehringer (efg@ncsu.edu)
#Akanksha Mohan (amohan7@ncsu.edu)

==Team Members==
#Shalin Rathi (sjrathi@ncsu.edu)
#Akshay Saxena (asaxena5@ncsu.edu)
#Daniel Mendez (dmendez@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/shalinshal/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://youtu.be/dVu0-LZcW1w Demo link]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz questionnaire controller.rb

2019-10-29T05:51:34Z

Sjrathi: /* Team Members */

==E1947. Refactoring quiz_questionnaire_controller.rb==

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

__TOC__

===About Expertiza===

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

===Problem Statement===
The following tasks were accomplished in this project:

* Rename filename such that it follows the coding standards
* Remove redundant information from method names
* Add comments to methods and complex lines of code
* Remove unsafe reflection method
* Simplify RSpec
* Try to fix issues from Code Climate

===About Quiz Questionnaire Controller===
This is a new controller, having recently been separated from questionnaires_controller.rb. It is used to allow students to take quizzes. The idea is that the author(s) of submitted work can write a quiz that is given to each reviewer before the reviewer is allowed to review the work. If the reviewer does badly on the quiz, then we know not to trust the review. It is also possible to set up an Expertiza assignment so that some participants just take the quiz and don’t review the work.

===Current Implementation===

=====Functionality=====
* A student can create a quiz questionnaire for the assignments that allow a quiz to be generated. This quiz will be taken by the reviewers, once they are done reviewing the development/project. Based on their answers the TA's can know whether to consider the reviewer's review or not based , because if the reviewer didn't perform well on the quiz, then it is likely that the review is not done properly.

* The maximum number of questions is decided by the instructor when creating the assignment.

* The student has option to either create True/False, Multiple-Choice Checkbox or Multiple-Choice Radio question.

* The question cannot be blank and correct answer must be selected to create a quiz.
 
=====Drawbacks and Solutions=====
* '''Problem 1''':Rename filename such that it follows the coding standards
'''Solution''':Currently the file was named as quiz_questionnaire_controller.rb. This doesn't follow the Ruby naming standards. Hence it was changed to quiz_questionnaires_controller.rb
* '''Problem 2''':Remove redundant information from method names
'''Solution''':Since this controller was separated from the questionnaires_controller.rb, the method names were kept the same from the previous controller which had redundant information.
Method names were renamed by removing the succeeding '_quiz'. Also valid_quiz was renamed to validate_quiz to make more sense. Also the routes.rb was changed to accept these changes.
* '''Problem 3''':Add comments to methods and complex lines of code
'''Solution''':Many methods had more than 325 lines of code and performed multiple functionalities. These methods were changed by creating private methods that performed individual tasks, thus reducing the lines of code and the complexity.
* '''Problem 4''':Remove unsafe reflection method
'''Solution''':This part was already implemented, hence no changes were made.
* '''Problem 5''':Try to fix issues from Code Climate
'''Solution''':Refer to Solution for Problem 3

===Code improvements===
* The method '''save_choices''' had a congnitive complexity of 23 and had 37 lines of code. By refactoring, the number of lines was reduced to 20 and private methods '''create_checkbox''', '''create_truefalse''' and '''create_radio''' were implemented to break up functionality and to reduce cognitive complexity.
'''Before:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
params[:new_choices][question_num.to_s][q_type].each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
q = if params[:new_choices][question_num.to_s][q_type][choice_key][:iscorrect] == 1.to_s
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
elsif q_type == "TrueFalse"
if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
q = QuizQuestionChoice.new(txt: "True", iscorrect: "true", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "false", question_id: question.id)
q.save
else
q = QuizQuestionChoice.new(txt: "True", iscorrect: "false", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "true", question_id: question.id)
q.save
end
else
q = if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
end
end
question_num += 1
question.weight = 1
end
end
</pre>
'''After:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
q_choices = params[:new_choices][question_num.to_s][q_type]
q_choices.each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
create_checkbox(question, choice_key, q_choices)
elsif q_type == "TrueFalse"
create_truefalse(question, choice_key, q_choices)
else # MultipleChoiceRadio
create_radio(question, choice_key, q_choices)
end
end
question_num += 1
question.weight = 1
end
end
</pre>

 
* The method '''action_allowed?''' has been implemented in quiz_questionnaire_controller.rb to specifically allow Student to edit an existing quiz.
 
* The quiz_questionnaire_controller_spec.rb has been updated to allow edit tests to work for Student role.
<pre>
let(:student) { build(:student, id: 8609) }
</pre>
'''Before:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''Before:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
 
* The method '''update_quiz''' has been renamed to '''update''' and has been refactored to reduce the line count by breaking functionalities. (The function '''multiple_choice_checkbox''' was renamed to '''update_checkbox''' and '''multiple_choice_radio''' was renamed to '''update_radio''' so as to reduce function name length and bring consistency with methods performing create operations: '''create_radio''', '''create_checkbox''', '''create_truefalse''')
The Cognitive Complexity of update method has now been reduced to 15 (from 29). 
'''Before:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
multiple_choice_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
multiple_choice_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
if @question.type == "TrueFalse"
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>

'''After:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)
params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save
@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
update_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
update_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
update_truefalse(question_choice) if @question.type == "TrueFalse"
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>
<pre>
def update_truefalse(question_choice)
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
</pre>

 
* The method '''valid_quiz''' has been renamed to '''validate_quiz'''. The function '''validate_question''' was extracted out to only validate the particular question. The part where quiz name was being verified was also taken out of the loop to only verify this once as opposed to verifying in each iteration, which was unnecessary. The Cognitive Complexity of 12 has now been reduced to less than 5.
'''Before:'''
<pre>
def valid_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"

(1..num_questions).each do |i|
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
elsif !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isnt selected for a question
valid = "Please select a type for each question"
else
@new_question = Object.const_get(params[:question_type][i.to_s][:type]).create(txt: '', type: params[:question_type][i.to_s][:type], break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
type = params[:question_type][i.to_s][:type]
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
break if valid != "valid"
end
valid
end
</pre>
'''After:'''
<pre>
def validate_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
end
(1..num_questions).each do |i|
break if valid != "valid"
valid = validate_question(i)
end
valid
end
</pre>
<pre>
def validate_question(i)
if !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isn't selected for a question
valid = "Please select a type for each question"
else
# The question type is dynamic, so const_get is necessary
type = params[:question_type][i.to_s][:type]
@new_question = Object.const_get(type).create(txt: '', type: type, break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
valid
end
</pre>

===Testing===
Link to [https://youtu.be/dVu0-LZcW1w video] showing the RSpec testing.
====Automated Testing using RSPEC====
[[File:RspecResults.png]]

====Testing from Travis CI====
[[File:TravisCIBuild.png]]
[[File:GitChecksPass.png]]

==Project Mentors==

Edward Gehringer (efg@ncsu.edu)

Akansha Mohan (amohan7@ncsu.edu)

==Team Members==
#Shalin Rathi (sjrathi@ncsu.edu)
#Akshay Saxena (asaxena5@ncsu.edu)
#Daniel Mendez (dmendez@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/shalinshal/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://youtu.be/dVu0-LZcW1w Demo link]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz questionnaire controller.rb

2019-10-29T05:51:23Z

Sjrathi: /* Team Members */

==E1947. Refactoring quiz_questionnaire_controller.rb==

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

__TOC__

===About Expertiza===

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

===Problem Statement===
The following tasks were accomplished in this project:

* Rename filename such that it follows the coding standards
* Remove redundant information from method names
* Add comments to methods and complex lines of code
* Remove unsafe reflection method
* Simplify RSpec
* Try to fix issues from Code Climate

===About Quiz Questionnaire Controller===
This is a new controller, having recently been separated from questionnaires_controller.rb. It is used to allow students to take quizzes. The idea is that the author(s) of submitted work can write a quiz that is given to each reviewer before the reviewer is allowed to review the work. If the reviewer does badly on the quiz, then we know not to trust the review. It is also possible to set up an Expertiza assignment so that some participants just take the quiz and don’t review the work.

===Current Implementation===

=====Functionality=====
* A student can create a quiz questionnaire for the assignments that allow a quiz to be generated. This quiz will be taken by the reviewers, once they are done reviewing the development/project. Based on their answers the TA's can know whether to consider the reviewer's review or not based , because if the reviewer didn't perform well on the quiz, then it is likely that the review is not done properly.

* The maximum number of questions is decided by the instructor when creating the assignment.

* The student has option to either create True/False, Multiple-Choice Checkbox or Multiple-Choice Radio question.

* The question cannot be blank and correct answer must be selected to create a quiz.
 
=====Drawbacks and Solutions=====
* '''Problem 1''':Rename filename such that it follows the coding standards
'''Solution''':Currently the file was named as quiz_questionnaire_controller.rb. This doesn't follow the Ruby naming standards. Hence it was changed to quiz_questionnaires_controller.rb
* '''Problem 2''':Remove redundant information from method names
'''Solution''':Since this controller was separated from the questionnaires_controller.rb, the method names were kept the same from the previous controller which had redundant information.
Method names were renamed by removing the succeeding '_quiz'. Also valid_quiz was renamed to validate_quiz to make more sense. Also the routes.rb was changed to accept these changes.
* '''Problem 3''':Add comments to methods and complex lines of code
'''Solution''':Many methods had more than 325 lines of code and performed multiple functionalities. These methods were changed by creating private methods that performed individual tasks, thus reducing the lines of code and the complexity.
* '''Problem 4''':Remove unsafe reflection method
'''Solution''':This part was already implemented, hence no changes were made.
* '''Problem 5''':Try to fix issues from Code Climate
'''Solution''':Refer to Solution for Problem 3

===Code improvements===
* The method '''save_choices''' had a congnitive complexity of 23 and had 37 lines of code. By refactoring, the number of lines was reduced to 20 and private methods '''create_checkbox''', '''create_truefalse''' and '''create_radio''' were implemented to break up functionality and to reduce cognitive complexity.
'''Before:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
params[:new_choices][question_num.to_s][q_type].each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
q = if params[:new_choices][question_num.to_s][q_type][choice_key][:iscorrect] == 1.to_s
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
elsif q_type == "TrueFalse"
if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
q = QuizQuestionChoice.new(txt: "True", iscorrect: "true", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "false", question_id: question.id)
q.save
else
q = QuizQuestionChoice.new(txt: "True", iscorrect: "false", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "true", question_id: question.id)
q.save
end
else
q = if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
end
end
question_num += 1
question.weight = 1
end
end
</pre>
'''After:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
q_choices = params[:new_choices][question_num.to_s][q_type]
q_choices.each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
create_checkbox(question, choice_key, q_choices)
elsif q_type == "TrueFalse"
create_truefalse(question, choice_key, q_choices)
else # MultipleChoiceRadio
create_radio(question, choice_key, q_choices)
end
end
question_num += 1
question.weight = 1
end
end
</pre>

 
* The method '''action_allowed?''' has been implemented in quiz_questionnaire_controller.rb to specifically allow Student to edit an existing quiz.
 
* The quiz_questionnaire_controller_spec.rb has been updated to allow edit tests to work for Student role.
<pre>
let(:student) { build(:student, id: 8609) }
</pre>
'''Before:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''Before:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
 
* The method '''update_quiz''' has been renamed to '''update''' and has been refactored to reduce the line count by breaking functionalities. (The function '''multiple_choice_checkbox''' was renamed to '''update_checkbox''' and '''multiple_choice_radio''' was renamed to '''update_radio''' so as to reduce function name length and bring consistency with methods performing create operations: '''create_radio''', '''create_checkbox''', '''create_truefalse''')
The Cognitive Complexity of update method has now been reduced to 15 (from 29). 
'''Before:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
multiple_choice_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
multiple_choice_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
if @question.type == "TrueFalse"
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>

'''After:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)
params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save
@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
update_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
update_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
update_truefalse(question_choice) if @question.type == "TrueFalse"
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>
<pre>
def update_truefalse(question_choice)
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
</pre>

 
* The method '''valid_quiz''' has been renamed to '''validate_quiz'''. The function '''validate_question''' was extracted out to only validate the particular question. The part where quiz name was being verified was also taken out of the loop to only verify this once as opposed to verifying in each iteration, which was unnecessary. The Cognitive Complexity of 12 has now been reduced to less than 5.
'''Before:'''
<pre>
def valid_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"

(1..num_questions).each do |i|
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
elsif !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isnt selected for a question
valid = "Please select a type for each question"
else
@new_question = Object.const_get(params[:question_type][i.to_s][:type]).create(txt: '', type: params[:question_type][i.to_s][:type], break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
type = params[:question_type][i.to_s][:type]
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
break if valid != "valid"
end
valid
end
</pre>
'''After:'''
<pre>
def validate_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
end
(1..num_questions).each do |i|
break if valid != "valid"
valid = validate_question(i)
end
valid
end
</pre>
<pre>
def validate_question(i)
if !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isn't selected for a question
valid = "Please select a type for each question"
else
# The question type is dynamic, so const_get is necessary
type = params[:question_type][i.to_s][:type]
@new_question = Object.const_get(type).create(txt: '', type: type, break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
valid
end
</pre>

===Testing===
Link to [https://youtu.be/dVu0-LZcW1w video] showing the RSpec testing.
====Automated Testing using RSPEC====
[[File:RspecResults.png]]

====Testing from Travis CI====
[[File:TravisCIBuild.png]]
[[File:GitChecksPass.png]]

==Project Mentors==

Edward Gehringer (efg@ncsu.edu)

Akansha Mohan (amohan7@ncsu.edu)

==Team Members==
#Shalin Rathi (sjrathi@ncsu.edu)

#Akshay Saxena (asaxena5@ncsu.edu)

#Daniel Mendez (dmendez@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/shalinshal/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://youtu.be/dVu0-LZcW1w Demo link]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz questionnaire controller.rb

2019-10-29T05:51:01Z

Sjrathi: /* References */

==E1947. Refactoring quiz_questionnaire_controller.rb==

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

__TOC__

===About Expertiza===

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

===Problem Statement===
The following tasks were accomplished in this project:

* Rename filename such that it follows the coding standards
* Remove redundant information from method names
* Add comments to methods and complex lines of code
* Remove unsafe reflection method
* Simplify RSpec
* Try to fix issues from Code Climate

===About Quiz Questionnaire Controller===
This is a new controller, having recently been separated from questionnaires_controller.rb. It is used to allow students to take quizzes. The idea is that the author(s) of submitted work can write a quiz that is given to each reviewer before the reviewer is allowed to review the work. If the reviewer does badly on the quiz, then we know not to trust the review. It is also possible to set up an Expertiza assignment so that some participants just take the quiz and don’t review the work.

===Current Implementation===

=====Functionality=====
* A student can create a quiz questionnaire for the assignments that allow a quiz to be generated. This quiz will be taken by the reviewers, once they are done reviewing the development/project. Based on their answers the TA's can know whether to consider the reviewer's review or not based , because if the reviewer didn't perform well on the quiz, then it is likely that the review is not done properly.

* The maximum number of questions is decided by the instructor when creating the assignment.

* The student has option to either create True/False, Multiple-Choice Checkbox or Multiple-Choice Radio question.

* The question cannot be blank and correct answer must be selected to create a quiz.
 
=====Drawbacks and Solutions=====
* '''Problem 1''':Rename filename such that it follows the coding standards
'''Solution''':Currently the file was named as quiz_questionnaire_controller.rb. This doesn't follow the Ruby naming standards. Hence it was changed to quiz_questionnaires_controller.rb
* '''Problem 2''':Remove redundant information from method names
'''Solution''':Since this controller was separated from the questionnaires_controller.rb, the method names were kept the same from the previous controller which had redundant information.
Method names were renamed by removing the succeeding '_quiz'. Also valid_quiz was renamed to validate_quiz to make more sense. Also the routes.rb was changed to accept these changes.
* '''Problem 3''':Add comments to methods and complex lines of code
'''Solution''':Many methods had more than 325 lines of code and performed multiple functionalities. These methods were changed by creating private methods that performed individual tasks, thus reducing the lines of code and the complexity.
* '''Problem 4''':Remove unsafe reflection method
'''Solution''':This part was already implemented, hence no changes were made.
* '''Problem 5''':Try to fix issues from Code Climate
'''Solution''':Refer to Solution for Problem 3

===Code improvements===
* The method '''save_choices''' had a congnitive complexity of 23 and had 37 lines of code. By refactoring, the number of lines was reduced to 20 and private methods '''create_checkbox''', '''create_truefalse''' and '''create_radio''' were implemented to break up functionality and to reduce cognitive complexity.
'''Before:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
params[:new_choices][question_num.to_s][q_type].each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
q = if params[:new_choices][question_num.to_s][q_type][choice_key][:iscorrect] == 1.to_s
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
elsif q_type == "TrueFalse"
if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
q = QuizQuestionChoice.new(txt: "True", iscorrect: "true", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "false", question_id: question.id)
q.save
else
q = QuizQuestionChoice.new(txt: "True", iscorrect: "false", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "true", question_id: question.id)
q.save
end
else
q = if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
end
end
question_num += 1
question.weight = 1
end
end
</pre>
'''After:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
q_choices = params[:new_choices][question_num.to_s][q_type]
q_choices.each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
create_checkbox(question, choice_key, q_choices)
elsif q_type == "TrueFalse"
create_truefalse(question, choice_key, q_choices)
else # MultipleChoiceRadio
create_radio(question, choice_key, q_choices)
end
end
question_num += 1
question.weight = 1
end
end
</pre>

 
* The method '''action_allowed?''' has been implemented in quiz_questionnaire_controller.rb to specifically allow Student to edit an existing quiz.
 
* The quiz_questionnaire_controller_spec.rb has been updated to allow edit tests to work for Student role.
<pre>
let(:student) { build(:student, id: 8609) }
</pre>
'''Before:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''Before:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
 
* The method '''update_quiz''' has been renamed to '''update''' and has been refactored to reduce the line count by breaking functionalities. (The function '''multiple_choice_checkbox''' was renamed to '''update_checkbox''' and '''multiple_choice_radio''' was renamed to '''update_radio''' so as to reduce function name length and bring consistency with methods performing create operations: '''create_radio''', '''create_checkbox''', '''create_truefalse''')
The Cognitive Complexity of update method has now been reduced to 15 (from 29). 
'''Before:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
multiple_choice_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
multiple_choice_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
if @question.type == "TrueFalse"
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>

'''After:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)
params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save
@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
update_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
update_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
update_truefalse(question_choice) if @question.type == "TrueFalse"
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>
<pre>
def update_truefalse(question_choice)
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
</pre>

 
* The method '''valid_quiz''' has been renamed to '''validate_quiz'''. The function '''validate_question''' was extracted out to only validate the particular question. The part where quiz name was being verified was also taken out of the loop to only verify this once as opposed to verifying in each iteration, which was unnecessary. The Cognitive Complexity of 12 has now been reduced to less than 5.
'''Before:'''
<pre>
def valid_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"

(1..num_questions).each do |i|
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
elsif !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isnt selected for a question
valid = "Please select a type for each question"
else
@new_question = Object.const_get(params[:question_type][i.to_s][:type]).create(txt: '', type: params[:question_type][i.to_s][:type], break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
type = params[:question_type][i.to_s][:type]
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
break if valid != "valid"
end
valid
end
</pre>
'''After:'''
<pre>
def validate_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
end
(1..num_questions).each do |i|
break if valid != "valid"
valid = validate_question(i)
end
valid
end
</pre>
<pre>
def validate_question(i)
if !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isn't selected for a question
valid = "Please select a type for each question"
else
# The question type is dynamic, so const_get is necessary
type = params[:question_type][i.to_s][:type]
@new_question = Object.const_get(type).create(txt: '', type: type, break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
valid
end
</pre>

===Testing===
Link to [https://youtu.be/dVu0-LZcW1w video] showing the RSpec testing.
====Automated Testing using RSPEC====
[[File:RspecResults.png]]

====Testing from Travis CI====
[[File:TravisCIBuild.png]]
[[File:GitChecksPass.png]]

==Project Mentors==

Edward Gehringer (efg@ncsu.edu)

Akansha Mohan (amohan7@ncsu.edu)

==Team Members==
Shalin Rathi (sjrathi@ncsu.edu)

Akshay Saxena (asaxena5@ncsu.edu)

Daniel Mendez (dmendez@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/shalinshal/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://youtu.be/dVu0-LZcW1w Demo link]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz questionnaire controller.rb

2019-10-29T05:50:19Z

Sjrathi: /* References */

==E1947. Refactoring quiz_questionnaire_controller.rb==

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

__TOC__

===About Expertiza===

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

===Problem Statement===
The following tasks were accomplished in this project:

* Rename filename such that it follows the coding standards
* Remove redundant information from method names
* Add comments to methods and complex lines of code
* Remove unsafe reflection method
* Simplify RSpec
* Try to fix issues from Code Climate

===About Quiz Questionnaire Controller===
This is a new controller, having recently been separated from questionnaires_controller.rb. It is used to allow students to take quizzes. The idea is that the author(s) of submitted work can write a quiz that is given to each reviewer before the reviewer is allowed to review the work. If the reviewer does badly on the quiz, then we know not to trust the review. It is also possible to set up an Expertiza assignment so that some participants just take the quiz and don’t review the work.

===Current Implementation===

=====Functionality=====
* A student can create a quiz questionnaire for the assignments that allow a quiz to be generated. This quiz will be taken by the reviewers, once they are done reviewing the development/project. Based on their answers the TA's can know whether to consider the reviewer's review or not based , because if the reviewer didn't perform well on the quiz, then it is likely that the review is not done properly.

* The maximum number of questions is decided by the instructor when creating the assignment.

* The student has option to either create True/False, Multiple-Choice Checkbox or Multiple-Choice Radio question.

* The question cannot be blank and correct answer must be selected to create a quiz.
 
=====Drawbacks and Solutions=====
* '''Problem 1''':Rename filename such that it follows the coding standards
'''Solution''':Currently the file was named as quiz_questionnaire_controller.rb. This doesn't follow the Ruby naming standards. Hence it was changed to quiz_questionnaires_controller.rb
* '''Problem 2''':Remove redundant information from method names
'''Solution''':Since this controller was separated from the questionnaires_controller.rb, the method names were kept the same from the previous controller which had redundant information.
Method names were renamed by removing the succeeding '_quiz'. Also valid_quiz was renamed to validate_quiz to make more sense. Also the routes.rb was changed to accept these changes.
* '''Problem 3''':Add comments to methods and complex lines of code
'''Solution''':Many methods had more than 325 lines of code and performed multiple functionalities. These methods were changed by creating private methods that performed individual tasks, thus reducing the lines of code and the complexity.
* '''Problem 4''':Remove unsafe reflection method
'''Solution''':This part was already implemented, hence no changes were made.
* '''Problem 5''':Try to fix issues from Code Climate
'''Solution''':Refer to Solution for Problem 3

===Code improvements===
* The method '''save_choices''' had a congnitive complexity of 23 and had 37 lines of code. By refactoring, the number of lines was reduced to 20 and private methods '''create_checkbox''', '''create_truefalse''' and '''create_radio''' were implemented to break up functionality and to reduce cognitive complexity.
'''Before:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
params[:new_choices][question_num.to_s][q_type].each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
q = if params[:new_choices][question_num.to_s][q_type][choice_key][:iscorrect] == 1.to_s
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
elsif q_type == "TrueFalse"
if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
q = QuizQuestionChoice.new(txt: "True", iscorrect: "true", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "false", question_id: question.id)
q.save
else
q = QuizQuestionChoice.new(txt: "True", iscorrect: "false", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "true", question_id: question.id)
q.save
end
else
q = if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
end
end
question_num += 1
question.weight = 1
end
end
</pre>
'''After:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
q_choices = params[:new_choices][question_num.to_s][q_type]
q_choices.each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
create_checkbox(question, choice_key, q_choices)
elsif q_type == "TrueFalse"
create_truefalse(question, choice_key, q_choices)
else # MultipleChoiceRadio
create_radio(question, choice_key, q_choices)
end
end
question_num += 1
question.weight = 1
end
end
</pre>

 
* The method '''action_allowed?''' has been implemented in quiz_questionnaire_controller.rb to specifically allow Student to edit an existing quiz.
 
* The quiz_questionnaire_controller_spec.rb has been updated to allow edit tests to work for Student role.
<pre>
let(:student) { build(:student, id: 8609) }
</pre>
'''Before:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''Before:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
 
* The method '''update_quiz''' has been renamed to '''update''' and has been refactored to reduce the line count by breaking functionalities. (The function '''multiple_choice_checkbox''' was renamed to '''update_checkbox''' and '''multiple_choice_radio''' was renamed to '''update_radio''' so as to reduce function name length and bring consistency with methods performing create operations: '''create_radio''', '''create_checkbox''', '''create_truefalse''')
The Cognitive Complexity of update method has now been reduced to 15 (from 29). 
'''Before:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
multiple_choice_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
multiple_choice_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
if @question.type == "TrueFalse"
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>

'''After:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)
params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save
@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
update_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
update_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
update_truefalse(question_choice) if @question.type == "TrueFalse"
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>
<pre>
def update_truefalse(question_choice)
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
</pre>

 
* The method '''valid_quiz''' has been renamed to '''validate_quiz'''. The function '''validate_question''' was extracted out to only validate the particular question. The part where quiz name was being verified was also taken out of the loop to only verify this once as opposed to verifying in each iteration, which was unnecessary. The Cognitive Complexity of 12 has now been reduced to less than 5.
'''Before:'''
<pre>
def valid_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"

(1..num_questions).each do |i|
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
elsif !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isnt selected for a question
valid = "Please select a type for each question"
else
@new_question = Object.const_get(params[:question_type][i.to_s][:type]).create(txt: '', type: params[:question_type][i.to_s][:type], break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
type = params[:question_type][i.to_s][:type]
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
break if valid != "valid"
end
valid
end
</pre>
'''After:'''
<pre>
def validate_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
end
(1..num_questions).each do |i|
break if valid != "valid"
valid = validate_question(i)
end
valid
end
</pre>
<pre>
def validate_question(i)
if !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isn't selected for a question
valid = "Please select a type for each question"
else
# The question type is dynamic, so const_get is necessary
type = params[:question_type][i.to_s][:type]
@new_question = Object.const_get(type).create(txt: '', type: type, break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
valid
end
</pre>

===Testing===
Link to [https://youtu.be/dVu0-LZcW1w video] showing the RSpec testing.
====Automated Testing using RSPEC====
[[File:RspecResults.png]]

====Testing from Travis CI====
[[File:TravisCIBuild.png]]
[[File:GitChecksPass.png]]

==Project Mentors==

Edward Gehringer (efg@ncsu.edu)

Akansha Mohan (amohan7@ncsu.edu)

==Team Members==
Shalin Rathi (sjrathi@ncsu.edu)

Akshay Saxena (asaxena5@ncsu.edu)

Daniel Mendez (dmendez@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/shalinshal/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://youtu.be/dVu0-LZcW1w Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz questionnaire controller.rb

2019-10-29T05:49:32Z

Sjrathi: /* References */

==E1947. Refactoring quiz_questionnaire_controller.rb==

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

__TOC__

===About Expertiza===

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

===Problem Statement===
The following tasks were accomplished in this project:

* Rename filename such that it follows the coding standards
* Remove redundant information from method names
* Add comments to methods and complex lines of code
* Remove unsafe reflection method
* Simplify RSpec
* Try to fix issues from Code Climate

===About Quiz Questionnaire Controller===
This is a new controller, having recently been separated from questionnaires_controller.rb. It is used to allow students to take quizzes. The idea is that the author(s) of submitted work can write a quiz that is given to each reviewer before the reviewer is allowed to review the work. If the reviewer does badly on the quiz, then we know not to trust the review. It is also possible to set up an Expertiza assignment so that some participants just take the quiz and don’t review the work.

===Current Implementation===

=====Functionality=====
* A student can create a quiz questionnaire for the assignments that allow a quiz to be generated. This quiz will be taken by the reviewers, once they are done reviewing the development/project. Based on their answers the TA's can know whether to consider the reviewer's review or not based , because if the reviewer didn't perform well on the quiz, then it is likely that the review is not done properly.

* The maximum number of questions is decided by the instructor when creating the assignment.

* The student has option to either create True/False, Multiple-Choice Checkbox or Multiple-Choice Radio question.

* The question cannot be blank and correct answer must be selected to create a quiz.
 
=====Drawbacks and Solutions=====
* '''Problem 1''':Rename filename such that it follows the coding standards
'''Solution''':Currently the file was named as quiz_questionnaire_controller.rb. This doesn't follow the Ruby naming standards. Hence it was changed to quiz_questionnaires_controller.rb
* '''Problem 2''':Remove redundant information from method names
'''Solution''':Since this controller was separated from the questionnaires_controller.rb, the method names were kept the same from the previous controller which had redundant information.
Method names were renamed by removing the succeeding '_quiz'. Also valid_quiz was renamed to validate_quiz to make more sense. Also the routes.rb was changed to accept these changes.
* '''Problem 3''':Add comments to methods and complex lines of code
'''Solution''':Many methods had more than 325 lines of code and performed multiple functionalities. These methods were changed by creating private methods that performed individual tasks, thus reducing the lines of code and the complexity.
* '''Problem 4''':Remove unsafe reflection method
'''Solution''':This part was already implemented, hence no changes were made.
* '''Problem 5''':Try to fix issues from Code Climate
'''Solution''':Refer to Solution for Problem 3

===Code improvements===
* The method '''save_choices''' had a congnitive complexity of 23 and had 37 lines of code. By refactoring, the number of lines was reduced to 20 and private methods '''create_checkbox''', '''create_truefalse''' and '''create_radio''' were implemented to break up functionality and to reduce cognitive complexity.
'''Before:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
params[:new_choices][question_num.to_s][q_type].each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
q = if params[:new_choices][question_num.to_s][q_type][choice_key][:iscorrect] == 1.to_s
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
elsif q_type == "TrueFalse"
if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
q = QuizQuestionChoice.new(txt: "True", iscorrect: "true", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "false", question_id: question.id)
q.save
else
q = QuizQuestionChoice.new(txt: "True", iscorrect: "false", question_id: question.id)
q.save
q = QuizQuestionChoice.new(txt: "False", iscorrect: "true", question_id: question.id)
q.save
end
else
q = if params[:new_choices][question_num.to_s][q_type][1.to_s][:iscorrect] == choice_key
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "true", question_id: question.id)
else
QuizQuestionChoice.new(txt: params[:new_choices][question_num.to_s][q_type][choice_key][:txt], iscorrect: "false", question_id: question.id)
end
q.save
end
end
question_num += 1
question.weight = 1
end
end
</pre>
'''After:'''
<pre>
def save_choices(questionnaire_id)
return unless params[:new_question] or params[:new_choices]
questions = Question.where(questionnaire_id: questionnaire_id)
question_num = 1

questions.each do |question|
q_type = params[:question_type][question_num.to_s][:type]
q_choices = params[:new_choices][question_num.to_s][q_type]
q_choices.each_key do |choice_key|
if q_type == "MultipleChoiceCheckbox"
create_checkbox(question, choice_key, q_choices)
elsif q_type == "TrueFalse"
create_truefalse(question, choice_key, q_choices)
else # MultipleChoiceRadio
create_radio(question, choice_key, q_choices)
end
end
question_num += 1
question.weight = 1
end
end
</pre>

 
* The method '''action_allowed?''' has been implemented in quiz_questionnaire_controller.rb to specifically allow Student to edit an existing quiz.
 
* The quiz_questionnaire_controller_spec.rb has been updated to allow edit tests to work for Student role.
<pre>
let(:student) { build(:student, id: 8609) }
</pre>
'''Before:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire is not taken by anyone' do
it 'renders questionnaires#edit page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(false)
params = {id: 1}
get :edit, params
expect(response).to render_template(:edit)
end
end
</pre>
'''Before:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
'''After:'''
<pre>
context 'when current questionnaire has been taken by someone' do
it 'shows flash[:error] message and redirects to submitted_content#view page' do
stub_current_user(student, student.role.name, student.role) #action only permitted for Student role
allow(@questionnaire).to receive(:taken_by_anyone?).and_return(true)
params = {id: 1, pid: 1}
get :edit, params
expect(flash[:error]).to eq('Your quiz has been taken by some other students, you cannot edit it anymore.')
expect(response).to redirect_to('/submitted_content/view?id=1')
end
end
end
</pre>
 
* The method '''update_quiz''' has been renamed to '''update''' and has been refactored to reduce the line count by breaking functionalities. (The function '''multiple_choice_checkbox''' was renamed to '''update_checkbox''' and '''multiple_choice_radio''' was renamed to '''update_radio''' so as to reduce function name length and bring consistency with methods performing create operations: '''create_radio''', '''create_checkbox''', '''create_truefalse''')
The Cognitive Complexity of update method has now been reduced to 15 (from 29). 
'''Before:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
multiple_choice_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
multiple_choice_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
if @question.type == "TrueFalse"
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>

'''After:'''
<pre>
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)
params[:question].each_key do |qid|
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save
@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
question_index = 1
@quiz_question_choices.each do |question_choice|
# Call to private method to handle Multile Choice Questions
update_checkbox(question_choice, question_index) if @question.type == "MultipleChoiceCheckbox"
update_radio(question_choice, question_index) if @question.type == "MultipleChoiceRadio"
update_truefalse(question_choice) if @question.type == "TrueFalse"
question_index += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
</pre>
<pre>
def update_truefalse(question_choice)
if params[:quiz_question_choices][@question.id.to_s][@question.type][1.to_s][:iscorrect] == "True" # the statement is correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '1') : question_choice.update_attributes(iscorrect: '0')
# the statement is correct so "True" is the right answer
else # the statement is not correct
question_choice.txt == "True" ? question_choice.update_attributes(iscorrect: '0') : question_choice.update_attributes(iscorrect: '1')
# the statement is not correct so "False" is the right answer
end
end
</pre>

 
* The method '''valid_quiz''' has been renamed to '''validate_quiz'''. The function '''validate_question''' was extracted out to only validate the particular question. The part where quiz name was being verified was also taken out of the loop to only verify this once as opposed to verifying in each iteration, which was unnecessary. The Cognitive Complexity of 12 has now been reduced to less than 5.
'''Before:'''
<pre>
def valid_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"

(1..num_questions).each do |i|
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
elsif !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isnt selected for a question
valid = "Please select a type for each question"
else
@new_question = Object.const_get(params[:question_type][i.to_s][:type]).create(txt: '', type: params[:question_type][i.to_s][:type], break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
type = params[:question_type][i.to_s][:type]
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
break if valid != "valid"
end
valid
end
</pre>
'''After:'''
<pre>
def validate_quiz
num_questions = Assignment.find(params[:aid]).num_quiz_questions
valid = "valid"
if params[:questionnaire][:name] == "" # questionnaire name is not specified
valid = "Please specify quiz name (please do not use your name or id)."
end
(1..num_questions).each do |i|
break if valid != "valid"
valid = validate_question(i)
end
valid
end
</pre>
<pre>
def validate_question(i)
if !params.key?(:question_type) || !params[:question_type].key?(i.to_s) || params[:question_type][i.to_s][:type].nil?
# A type isn't selected for a question
valid = "Please select a type for each question"
else
# The question type is dynamic, so const_get is necessary
type = params[:question_type][i.to_s][:type]
@new_question = Object.const_get(type).create(txt: '', type: type, break_before: true)
@new_question.update_attributes(txt: params[:new_question][i.to_s])
choice_info = params[:new_choices][i.to_s][type] # choice info for one question of its type
valid = if choice_info.nil?
"Please select a correct answer for all questions"
else
@new_question.isvalid(choice_info)
end
end
valid
end
</pre>

===Testing===
Link to [https://youtu.be/dVu0-LZcW1w video] showing the RSpec testing.
====Automated Testing using RSPEC====
[[File:RspecResults.png]]

====Testing from Travis CI====
[[File:TravisCIBuild.png]]
[[File:GitChecksPass.png]]

==Project Mentors==

Edward Gehringer (efg@ncsu.edu)

Akansha Mohan (amohan7@ncsu.edu)

==Team Members==
Shalin Rathi (sjrathi@ncsu.edu)

Akshay Saxena (asaxena5@ncsu.edu)

Daniel Mendez (dmendez@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://youtu.be/dVu0-LZcW1w Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin