Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:51:38Z

Ywang95: /* Background */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Rust===
Rust is a general purpose, [http://en.wikipedia.org/wiki/Programming_paradigm#Multi-paradigm multi-paradigm], compiled programming language developed by [http://en.wikipedia.org/wiki/Mozilla Mozilla] Research. It is designed to be a "safe, concurrent, practical language", supporting [http://en.wikipedia.org/wiki/Purely_functional pure-functional], [http://en.wikipedia.org/wiki/Actor_model concurrent-actor], [http://en.wikipedia.org/wiki/Procedural_programming imperative-procedural], and object-oriented styles.<ref>http://en.wikipedia.org/wiki/Rust_%28programming_language%29</ref> Being a modern systems programming language focusing on safety and speed, it accomplishes these goals by being memory safe without using garbage collection.<ref>http://doc.rust-lang.org/nightly/intro.html</ref>

===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.
Servo builds on top of Rust to provide a secure and reliable foundation. Memory safety at the core of the platform ensures a high degree of assurance in the browser’s trusted computing base. Rust’s lightweight task mechanism also promises to allow fine-grained isolation between browser components, such as tabs and extensions, without the need for expensive runtime protection schemes, like operating system process isolation.<ref>https://www.mozilla.org/en-US/research/projects/</ref>

=='''Background'''==
Firefox supports remote developer tools - ie. communicating with an arbitrary server that implements a protocol for exposing information about web content. Servo implements a very basic developer tools server that currently supports executing JS remotely and investigating the DOM tree in the document inspector. We want to expand these capabilities by completing previous work that enables remote logging from web content, and add new capabilities to log HTTP requests and responses to allow for easier debugging of network-related problems in Servo.<ref>https://github.com/servo/servo/wiki/More-developer-tools-student-project</ref>
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:49:58Z

Ywang95: /* Rust */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Rust===
Rust is a general purpose, [http://en.wikipedia.org/wiki/Programming_paradigm#Multi-paradigm multi-paradigm], compiled programming language developed by [http://en.wikipedia.org/wiki/Mozilla Mozilla] Research. It is designed to be a "safe, concurrent, practical language", supporting [http://en.wikipedia.org/wiki/Purely_functional pure-functional], [http://en.wikipedia.org/wiki/Actor_model concurrent-actor], [http://en.wikipedia.org/wiki/Procedural_programming imperative-procedural], and object-oriented styles.<ref>http://en.wikipedia.org/wiki/Rust_%28programming_language%29</ref> Being a modern systems programming language focusing on safety and speed, it accomplishes these goals by being memory safe without using garbage collection.<ref>http://doc.rust-lang.org/nightly/intro.html</ref>

===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.
Servo builds on top of Rust to provide a secure and reliable foundation. Memory safety at the core of the platform ensures a high degree of assurance in the browser’s trusted computing base. Rust’s lightweight task mechanism also promises to allow fine-grained isolation between browser components, such as tabs and extensions, without the need for expensive runtime protection schemes, like operating system process isolation.<ref>https://www.mozilla.org/en-US/research/projects/</ref>

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:46:57Z

Ywang95: /* Rust */

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:44:14Z

Ywang95: /* Rust */

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:43:40Z

Ywang95: /* Servo */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Rust===
Rust is a general purpose, multi-paradigm<, compiled programming language developed by Mozilla Research.[11] It is designed to be a "safe, concurrent, practical language", supporting pure-functional, concurrent-actor, imperative-procedural, and object-oriented styles.<ref>http://en.wikipedia.org/wiki/Rust_%28programming_language%29</ref>

===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.
Servo builds on top of Rust to provide a secure and reliable foundation. Memory safety at the core of the platform ensures a high degree of assurance in the browser’s trusted computing base. Rust’s lightweight task mechanism also promises to allow fine-grained isolation between browser components, such as tabs and extensions, without the need for expensive runtime protection schemes, like operating system process isolation.<ref>https://www.mozilla.org/en-US/research/projects/</ref>

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:42:54Z

Ywang95: /* Servo */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Rust===
Rust is a general purpose, multi-paradigm<, compiled programming language developed by Mozilla Research.[11] It is designed to be a "safe, concurrent, practical language", supporting pure-functional, concurrent-actor, imperative-procedural, and object-oriented styles.<ref>http://en.wikipedia.org/wiki/Rust_%28programming_language%29</ref>

===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.
Servo builds on top of Rust to provide a secure and reliable foundation. Memory safety at the core of the platform ensures a high degree of assurance in the browser’s trusted computing base. Rust’s lightweight task mechanism also promises to allow fine-grained isolation between browser components, such as tabs and extensions, without the need for expensive runtime protection schemes, like operating system process isolation.<ref>Mozilla Research Projects, from https://www.mozilla.org/en-US/research/projects/</ref>

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:42:22Z

Ywang95: /* Servo */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Rust===
Rust is a general purpose, multi-paradigm<, compiled programming language developed by Mozilla Research.[11] It is designed to be a "safe, concurrent, practical language", supporting pure-functional, concurrent-actor, imperative-procedural, and object-oriented styles.<ref>http://en.wikipedia.org/wiki/Rust_%28programming_language%29</ref>

===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.
Servo builds on top of Rust to provide a secure and reliable foundation. Memory safety at the core of the platform ensures a high degree of assurance in the browser’s trusted computing base. Rust’s lightweight task mechanism also promises to allow fine-grained isolation between browser components, such as tabs and extensions, without the need for expensive runtime protection schemes, like operating system process isolation.<ref>Mozilla Research Projects https://www.mozilla.org/en-US/research/projects/</ref>

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:41:54Z

Ywang95: /* Rusthttp://en.wikipedia.org/wiki/Rust_%28programming_language%29 */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Rust===
Rust is a general purpose, multi-paradigm<, compiled programming language developed by Mozilla Research.[11] It is designed to be a "safe, concurrent, practical language", supporting pure-functional, concurrent-actor, imperative-procedural, and object-oriented styles.<ref>http://en.wikipedia.org/wiki/Rust_%28programming_language%29</ref>

===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.
Servo builds on top of Rust to provide a secure and reliable foundation. Memory safety at the core of the platform ensures a high degree of assurance in the browser’s trusted computing base. Rust’s lightweight task mechanism also promises to allow fine-grained isolation between browser components, such as tabs and extensions, without the need for expensive runtime protection schemes, like operating system process isolation.<ref> https://www.mozilla.org/en-US/research/projects/</ref>

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:39:27Z

Ywang95: /* Introduction */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Rust<ref>http://en.wikipedia.org/wiki/Rust_%28programming_language%29</ref>===
Rust is a general purpose, multi-paradigm, compiled programming language developed by Mozilla Research.[11] It is designed to be a "safe, concurrent, practical language", supporting pure-functional, concurrent-actor, imperative-procedural, and object-oriented styles.
===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.
Servo builds on top of Rust to provide a secure and reliable foundation. Memory safety at the core of the platform ensures a high degree of assurance in the browser’s trusted computing base. Rust’s lightweight task mechanism also promises to allow fine-grained isolation between browser components, such as tabs and extensions, without the need for expensive runtime protection schemes, like operating system process isolation.<ref> https://www.mozilla.org/en-US/research/projects/</ref>

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:35:48Z

Ywang95:

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.<ref> https://www.mozilla.org/en-US/research/projects/</ref>

===Rust===

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

=='''Reference'''==
<references/>

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:35:38Z

Ywang95:

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:35:07Z

Ywang95:

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:34:37Z

Ywang95: /* Servo */

CSC/ECE 517 Spring 2015 M1503 EDTS

2015-03-31T03:34:03Z

Ywang95: /* Servo */

Extending Developer Tools for Servo
__TOC__
=='''Introduction'''==
===Servo===
Servo is an experimental project to build a Web browser engine for a new generation of hardware: mobile devices, multi-core processors and high-performance GPUs. With Servo, we are rethinking the browser at every level of the technology stack — from input parsing to page layout to graphics rendering — to optimize for power efficiency and maximum parallelism.[ref=https://www.mozilla.org/en-US/research/projects/]

===Rust===

=='''Background'''==
===Remote Developer Tools===

=='''Project Description'''==
=='''Requirement Analysis'''==
=='''Implementation'''==
=='''Architecture'''==
=='''Design Patterns'''==
=='''UML Diagrams'''==
=='''Proposed Test Cases'''==

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:44:10Z

Ywang95: /* Method Refactoring */

==E1502: Questionnaire Controller Refactoring==
In this project, we have done some refactoring on the questionnaires_controller. We moved some methods to where we thought suited them, and changed the format of language into ruby style, deleted debugging statement. Details are displayed in the following sections.

==Introduction to Expertiza==
The Expertiza project is system for using peer review to create reusable learning objects. Students do different assignments; then peer review selects the best work in each category, and assembles it to create a single unit.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to be put in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}

===Format Refactoring===
====Case 1: Loop Condition====
Change all the looping conditions into one format 
Before
<pre>
# Remove a given questionnaire
def delete
.
.
.
for question in @questionnaire.questions
.
.
.
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
.
.
.
@questionnaire.assignments.each
.
.
.
end
</pre>

====Case 2: If Condition====
Change all the if conditions into ruby format 
Before
<pre>
.
.
if @successful_create == true
.
.
unless this_q.nil?
.
.
</pre>
After
<pre>
.
.
if @successful_create
.
.
if this_q
.
.
</pre>

====Case 3: Name====
Change all the name from "JAVA name" to "Ruby name" 
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>
===Refactoring Example===
In models/questionnaires.rb, we add copy_questionnaires method, as shown below:
<pre>
def self.copy_questionnaires(id,user)
@orig_questionnaire = Questionnaire.find(id)
questions = Question.where(questionnaire_id: id)
@questionnaire = @orig_questionnaire.clone
@questionnaire.instructor_id = user.instructor_id ## Why was TA-specific code removed here? See Project E713.
@questionnaire.name = 'Copy of ' + @orig_questionnaire.name

if user.role.name != "Teaching Assistant"
@questionnaire.instructor_id = user.id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
@questionnaire.instructor_id = Ta.get_my_instructor(user.id)
end
@questionnaire.name = 'Copy of '+@orig_questionnaire.name

@questionnaire.created_at = Time.now
@questionnaire.save!

questions.each{ | question |

new_question = question.clone
new_question.questionnaire_id = @questionnaire.id
new_question.save

advice = QuestionAdvice.find_by_question_id(question.id)
if advice
new_advice = advice.clone
new_advice.question_id = newquestion.id
new_advice.save
end

if (@questionnaire.section == "Custom")
old_question_type = QuestionType.find_by_question_id(question.id)
if old_question_type
new_question_type = old_question_type.clone
new_question_type.question_id = newquestion.id
new_question_type.save
end
end
}
pFolder = TreeFolder.find_by_name(@questionnaire.display_type)
parent = FolderNode.find_by_node_object_id(pFolder.id)
unless QuestionnaireNode.where(parent_id: parent.id, node_object_id: @questionnaire.id)
QuestionnaireNode.create(:parent_id => parent.id, :node_object_id => @questionnaire.id)
end
end
</pre>

==References==
<references/>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:43:49Z

Ywang95: /* Method Refactoring */

==E1502: Questionnaire Controller Refactoring==
In this project, we have done some refactoring on the questionnaires_controller. We moved some methods to where we thought suited them, and changed the format of language into ruby style, deleted debugging statement. Details are displayed in the following sections.

==Introduction to Expertiza==
The Expertiza project is system for using peer review to create reusable learning objects. Students do different assignments; then peer review selects the best work in each category, and assembles it to create a single unit.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as <a href="#example">copy_questionnaires</a> method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to be put in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}

===Format Refactoring===
====Case 1: Loop Condition====
Change all the looping conditions into one format 
Before
<pre>
# Remove a given questionnaire
def delete
.
.
.
for question in @questionnaire.questions
.
.
.
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
.
.
.
@questionnaire.assignments.each
.
.
.
end
</pre>

====Case 2: If Condition====
Change all the if conditions into ruby format 
Before
<pre>
.
.
if @successful_create == true
.
.
unless this_q.nil?
.
.
</pre>
After
<pre>
.
.
if @successful_create
.
.
if this_q
.
.
</pre>

====Case 3: Name====
Change all the name from "JAVA name" to "Ruby name" 
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>
===Refactoring Example===
In models/questionnaires.rb, we add copy_questionnaires method, as shown below:
<pre>
def self.copy_questionnaires(id,user)
@orig_questionnaire = Questionnaire.find(id)
questions = Question.where(questionnaire_id: id)
@questionnaire = @orig_questionnaire.clone
@questionnaire.instructor_id = user.instructor_id ## Why was TA-specific code removed here? See Project E713.
@questionnaire.name = 'Copy of ' + @orig_questionnaire.name

if user.role.name != "Teaching Assistant"
@questionnaire.instructor_id = user.id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
@questionnaire.instructor_id = Ta.get_my_instructor(user.id)
end
@questionnaire.name = 'Copy of '+@orig_questionnaire.name

@questionnaire.created_at = Time.now
@questionnaire.save!

questions.each{ | question |

new_question = question.clone
new_question.questionnaire_id = @questionnaire.id
new_question.save

advice = QuestionAdvice.find_by_question_id(question.id)
if advice
new_advice = advice.clone
new_advice.question_id = newquestion.id
new_advice.save
end

if (@questionnaire.section == "Custom")
old_question_type = QuestionType.find_by_question_id(question.id)
if old_question_type
new_question_type = old_question_type.clone
new_question_type.question_id = newquestion.id
new_question_type.save
end
end
}
pFolder = TreeFolder.find_by_name(@questionnaire.display_type)
parent = FolderNode.find_by_node_object_id(pFolder.id)
unless QuestionnaireNode.where(parent_id: parent.id, node_object_id: @questionnaire.id)
QuestionnaireNode.create(:parent_id => parent.id, :node_object_id => @questionnaire.id)
end
end
</pre>

==References==
<references/>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:42:58Z

Ywang95: /* Refactoring Example */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:40:13Z

Ywang95: /* What We Have Done */

==E1502: Questionnaire Controller Refactoring==
In this project, we have done some refactoring on the questionnaires_controller. We moved some methods to where we thought suited them, and changed the format of language into ruby style, deleted debugging statement. Details are displayed in the following sections.

==Introduction to Expertiza==
The Expertiza project is system for using peer review to create reusable learning objects. Students do different assignments; then peer review selects the best work in each category, and assembles it to create a single unit.<ref>[http://expertiza.ncsu.edu/ Expertiza]</ref>

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to be put in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}

===Format Refactoring===
====Case 1: Loop Condition====
Change all the looping conditions into one format 
Before
<pre>
# Remove a given questionnaire
def delete
.
.
.
for question in @questionnaire.questions
.
.
.
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
.
.
.
@questionnaire.assignments.each
.
.
.
end
</pre>

====Case 2: If Condition====
Change all the if conditions into ruby format 
Before
<pre>
.
.
if @successful_create == true
.
.
unless this_q.nil?
.
.
</pre>
After
<pre>
.
.
if @successful_create
.
.
if this_q
.
.
</pre>

====Case 3: Name====
Change all the name from "JAVA name" to "Ruby name" 
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>
===Refactoring Example===
In models/questionnaires.rb, we add copy_questionnaires method, as shown below:
<pre>
def self.copy_questionnaires(id,user)
@orig_questionnaire = Questionnaire.find(id)
questions = Question.where(questionnaire_id: id)
@questionnaire = @orig_questionnaire.clone
@questionnaire.instructor_id = user.instructor_id ## Why was TA-specific code removed here? See Project E713.
@questionnaire.name = 'Copy of ' + @orig_questionnaire.name

if user.role.name != "Teaching Assistant"
@questionnaire.instructor_id = user.id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
@questionnaire.instructor_id = Ta.get_my_instructor(user.id)
end
@questionnaire.name = 'Copy of '+@orig_questionnaire.name

@questionnaire.created_at = Time.now
@questionnaire.save!

questions.each{ | question |

new_question = question.clone
new_question.questionnaire_id = @questionnaire.id
new_question.save

advice = QuestionAdvice.find_by_question_id(question.id)
if advice
new_advice = advice.clone
new_advice.question_id = newquestion.id
new_advice.save
end

if (@questionnaire.section == "Custom")
old_question_type = QuestionType.find_by_question_id(question.id)
if old_question_type
new_question_type = old_question_type.clone
new_question_type.question_id = newquestion.id
new_question_type.save
end
end
}
pFolder = TreeFolder.find_by_name(@questionnaire.display_type)
parent = FolderNode.find_by_node_object_id(pFolder.id)
unless QuestionnaireNode.where(parent_id: parent.id, node_object_id: @questionnaire.id)
QuestionnaireNode.create(:parent_id => parent.id, :node_object_id => @questionnaire.id)
end
end
</pre>

==References==
<references/>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:34:27Z

Ywang95:

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:33:24Z

Ywang95:

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:32:56Z

Ywang95: /* Introduction to Expertiza */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T23:25:05Z

Ywang95: /* What we have left */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:21:10Z

Ywang95: /* E1502: Questionnaire Controller Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:20:39Z

Ywang95: /* What we have left */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:12:54Z

Ywang95: /* E1502: Questionnaire Controller Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:08:55Z

Ywang95:

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:06:22Z

Ywang95: /* Case 3: Name */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:03:28Z

Ywang95: /* Method Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:01:10Z

Ywang95: /* Case 2: if Condition */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:00:51Z

Ywang95: /* E1502: Questionnaire Controller Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T03:00:29Z

Ywang95: /* Case 2: if Condition */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
====Case 1: Loop Condition====
Change all the looping conditions into one format 
Before
<pre>
# Remove a given questionnaire
def delete
.
.
.
for question in @questionnaire.questions
.
.
.
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
.
.
.
@questionnaire.assignments.each
.
.
.
end
</pre>

====Case 2: if Condition====
Change all the if conditions into ruby format 
Before
<pre>
.
.
if @successful_create == true
.
.
unless this_q.nil?
.
.
</pre>
After
<pre>
.
.
if @successful_create
.
.
if this_q
.
.
</pre>

====Case 3: Name====
Change all the name from "JAVA name" to "Ruby name"
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:59:44Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
====Case 1: Loop Condition====
Change all the looping conditions into one format 
Before
<pre>
# Remove a given questionnaire
def delete
.
.
.
for question in @questionnaire.questions
.
.
.
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
.
.
.
@questionnaire.assignments.each
.
.
.
end
</pre>

====Case 2: if Condition====
Change all the if conditions into ruby format 
Before
<pre>
if @successful_create == true
unless this_q.nil?
</pre>
After
<pre>
if @successful_create
if this_q
</pre>
====Case 3: Name====
Change all the name from "JAVA name" to "Ruby name"
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:56:10Z

Ywang95: /* Case 1: Loop */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
====Case 1: Loop Condition====
Change all the looping conditions into one format 
Before
<pre>
# Remove a given questionnaire
def delete
.
.
.
for question in @questionnaire.questions
.
.
.
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
.
.
.
@questionnaire.assignments.each
.
.
.
end
</pre>

====Case 2: Name====
Change all the name from "JAVA name" to "Ruby name"
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:55:43Z

Ywang95: /* Case 1: Loop */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
====Case 1: Loop====
Change all the looping conditions into one format 
Before
<pre>
# Remove a given questionnaire
def delete
.
.
.
for question in @questionnaire.questions
.
.
.
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
.
.
.
@questionnaire.assignments.each
.
.
.
end
</pre>

====Case 2: Name====
Change all the name from "JAVA name" to "Ruby name"
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:53:10Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
====Case 1: Loop====
Change all from "for question in @questionnaire.questions" to "@questionnaire.questions.each do |question|" 
Before
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
====Case 2: Name====
Change all the name from "JAVA name" to "Ruby name"
Before
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
questionnum=1
.
.
.
end
</pre>
After
<pre>
#save an updated quiz questionnaire to the database
def update_quiz
.
.
.
question_num=1
.
.
.
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:48:30Z

Ywang95: /* Case 1: Loop */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
====Case 1: Loop====
Change from "for question in @questionnaire.questions" to "@questionnaire.questions.each do |question|" 
Before
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:47:54Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
====Case 1: Loop====
Change from "for question in @questionnaire.questions" to "@questionnaire.questions.each do |question|" 
Before
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:47:22Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
Case 1: 
Change from "for question in @questionnaire.questions" to "@questionnaire.questions.each do |question|" 
Before
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:46:50Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
Case 1: 
Change from "for question in @questionnaire.questions" to "@questionnaire.questions.each do |question|" 
Before
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:45:53Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
Case 1: 
Change from "for question in @questionnaire.questions" to "@questionnaire.questions.each do |question|" 
Before

# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end

After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:45:33Z

Ywang95:

==E1502: Questionnaire Controller Refactoring==
red writing
==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
Case 1: 
Change from "for question in @questionnaire.questions" to "@questionnaire.questions.each do |question|" 
Before
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:45:15Z

Ywang95:

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:44:55Z

Ywang95:

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:43:03Z

Ywang95: /* Format Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:41:14Z

Ywang95: /* Format Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:40:15Z

Ywang95: /* Format Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:39:34Z

Ywang95: /* Format Refactoring */

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:39:15Z

Ywang95:

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:38:37Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==

==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
Case 1:
change from "for xx in xx" to "xx.each do |xx|"
Before
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
After
<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>

===Moving code to the proper place===
The ResponseController allows the user to create and edit responses to questionnaires, in doing so, there needs to be some sort of authentication, and the proper place for that is in the action_allowed? method, however the un-refactored code did in the redirect_when_disallowed method. Moreover, once this code was moved to the action_allowed? method, all of the references to redirect_when_disallowed were changed to action_allowed? (left out of wiki for brevity).

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def action_allowed?
current_user
end

def redirect_when_disallowed(response)
# For author feedback, participants need to be able to read feedback submitted by other teammates.
# If response is anything but author feedback, only the person who wrote feedback should be able to see it.
if response.map.read_attribute(:type) == 'FeedbackResponseMap' && response.map.assignment.team_assignment?
team = response.map.reviewer.team
unless team.has_user session[:user]
redirect_to '/denied?reason=You are not on the team that wrote this feedback'
else
return false
end
response.map.read_attribute(:type)
end
!current_user_id?(response.map.reviewer.user_id)
end
</pre>
|<pre>
def action_allowed?(response)
# For author feedback, participants need to be able to read feedback submitted by other teammates.
# If response is anything but author feedback, only the person who wrote feedback should be able to see it.
if response.map.read_attribute(:type) == 'FeedbackResponseMap' && response.map.assignment.team_assignment?
team = response.map.reviewer.team
unless team.has_user session[:user]
redirect_to '/denied?reason=You are not on the team that wrote this feedback'
else
return false
end
response.map.read_attribute(:type)
end
!current_user_id?(response.map.reviewer.user_id)
end
</pre>
|}

CSC/ECE 517 Fall 2014/oss E1502 wwj

2015-03-21T02:35:12Z

Ywang95: /* Format Refactoring */

==E1502: Questionnaire Controller Refactoring==

==Introduction to Expertiza==

==Project Description==
===What it does:===
Used on the admin side of Expertiza for creating/ editing questionnaires (rubrics, surveys and quizzes). It helps in add/removing questions, options, etc for a questionnaire.
<li>Very big controller that handles a lot more than the name suggests. Functionalities need to be moved to appropriate controllers.
<li>Quiz methods are should be treated the same as any other type of questionnaire; differences between quiz questionnaires and other questionnaires should be implemented in the model class, quiz_questionnaire
<li>Turn the questionnaire into a “form object.” The ..._questions methods: save_new_questions, delete_questions, save_questions should be in a separate class.
===Other classes involved:===
<li>questionnaire.rb
<li>quiz_questionnaire.rb
<li>questions_controller.rb

===What needs to be done:===
<li>Move quiz related functions to quiz_questionnaire.rb.
<li>copy, update_quiz, valid_quiz methods, clone_questionnaire_details is too long.
<li>Debug output (print statements) should be removed.
<li>Understand the functions in the controller and comment them. Ensure that the code is understandable to the next programmer who works on it.

==What We Have Done==
===Method Refactoring===
{| class="wikitable"
|-
! style="width:13%;"|Method Name
! style="width:33%;"|Changes Made
! style="width:43%;"|Reason For Change
|- style="vertical-align:top;"
| copy
| Extracted the content of this method as copy_questionnaires method and put it in questionnaire.rb
| The content of this method is about operations on the database (coping a questionnaire), it is better to put it in the model
|-
| valid_quiz
| Moved this method to quiz_questionnaire.rb
| This method is about validation of the quiz, it shouldn't appear in the controller
|-
| export
| Moved this method to questionnaire.rb
| This method exports the questionnaires as csv file, it should't appear in the controller
|-
| import
| Moved this method to questionnaire.rb
| This method imports the questionnaires from csv file, it should't appear in the controller
|-
| clone_questionnaire_details
| Deleted this method due to the duplication
| Substituted by copy_questionnaires method in questionnaire.rb
|-
|}
===Format Refactoring===
{| class="wikitable"
|-
! |Before
! |After
|- style="vertical-align:bottom;"
|<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

for question in @questionnaire.questions
current_q_type = QuestionType.find_by_question_id(question.id)
unless current_q_type.nil?
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
|<pre>
# Remove a given questionnaire
def delete
@questionnaire = Questionnaire.find(params[:id])

if @questionnaire
begin
name = @questionnaire.name

@questionnaire.questions.each do |question|
current_q_type = QuestionType.find_by_question_id(question.id)
if current_q_type
current_q_type.delete
end
end
@questionnaire.assignments.each{
| assignment |
raise "The assignment #{assignment.name} uses this questionnaire. Do you want to <A href='../assignment/delete/#{assignment.id}'>delete</A> the assignment?"
}
@questionnaire.destroy
undo_link("Questionnaire \"#{name}\" has been deleted successfully. ")
rescue
flash[:error] = $!
end
end

redirect_to :action => 'list', :controller => 'tree_display'
end
</pre>
|- style="vertical-align:bottom;"
|<pre>
def view
@response = Response.find(params[:id])
return if redirect_when_disallowed(@response)
@map = @response.map
get_content
@review_scores = Array.new
@question_type = Array.new
@questions.each do |question|
@review_scores << Score.where(response_id: @map.response_id, question_id: question.id).first
@question_type << QuestionType.find_by_question_id(question.id)
end
end

def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|<pre>
def view
@response = Response.find(params[:id])
return if action_allowed?(@response)
@map = @response.map
get_content
get_scores(@response, @questions)
end
</pre>
|}

===Moving code to the proper place===
The ResponseController allows the user to create and edit responses to questionnaires, in doing so, there needs to be some sort of authentication, and the proper place for that is in the action_allowed? method, however the un-refactored code did in the redirect_when_disallowed method. Moreover, once this code was moved to the action_allowed? method, all of the references to redirect_when_disallowed were changed to action_allowed? (left out of wiki for brevity).

{| class="wikitable"
|-
! |Before Changes
! |After Changes
|- style="vertical-align:top;"
|<pre>
def action_allowed?
current_user
end

def redirect_when_disallowed(response)
# For author feedback, participants need to be able to read feedback submitted by other teammates.
# If response is anything but author feedback, only the person who wrote feedback should be able to see it.
if response.map.read_attribute(:type) == 'FeedbackResponseMap' && response.map.assignment.team_assignment?
team = response.map.reviewer.team
unless team.has_user session[:user]
redirect_to '/denied?reason=You are not on the team that wrote this feedback'
else
return false
end
response.map.read_attribute(:type)
end
!current_user_id?(response.map.reviewer.user_id)
end
</pre>
|<pre>
def action_allowed?(response)
# For author feedback, participants need to be able to read feedback submitted by other teammates.
# If response is anything but author feedback, only the person who wrote feedback should be able to see it.
if response.map.read_attribute(:type) == 'FeedbackResponseMap' && response.map.assignment.team_assignment?
team = response.map.reviewer.team
unless team.has_user session[:user]
redirect_to '/denied?reason=You are not on the team that wrote this feedback'
else
return false
end
response.map.read_attribute(:type)
end
!current_user_id?(response.map.reviewer.user_id)
end
</pre>
|}