CSC/ECE 517 Fall 2016/E1673. Refactor question type.rb

Background

Expertiza is an open source software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages. It has following features:

• Enables students working together in a class and a topic
• Enables studnets to do peer review and improve both him/her and others' learn experience

Reason for Refractor

The purpose of this work is to rewrite the part of the codes in the Criterion.rb, Scale.rb, Checkbox.rb, Dropdown.rb, Text_response.rb, Text_area.rb, Text_field.rb, for some of codes have bad writing sytle, or not followingg OO language rules. The detail of the requirements are list below

• Line is too long
• Some code found in other location and should put them in the parent class
• Method has too many lines
• Some of the code will cause security risk
• Using the old style validations
• Using a lower efficent way to do the loop

Code Changes

text_field.rb

Although it increase the number of classes, the length of function decrease and it's easy to read than before

def view_completed_question(count, answer)
   if self.type == 'TextField' and self.break_before == true
     html = view_helper_true(count, answer)
     html += if Question.exists?(answer.question_id + 1) && Question.find(answer.question_id + 1).break_before == true
   else
     html = view_helper_false(answer)
   end
   safe_join([" ".html_safe, " ".html_safe], html.html_safe)
end

text_response.rb

It makes codes more readable. We also choose safe_join instead of html_safe to prevent security risks. However, we must use html_safe to keep the character encoding.

def edit(_count)
   html = edit_link + edit_question_lable
   html += edit_question_textarea + edit_question_textarea_size

safe_join(["".html_safe, "".html_safe], html.html_safe) end