Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2016 E1624 Compose functional tests for Suggest topics of student functionality

2016-04-15T00:16:44Z

Hguan2: /* Step 4 Approve/Reject the suggested topic */

This wiki page is for the description of changes made under E1624 Final project design assignment for Spring 2016, CSC/ECE 517.

==Problem Statement==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for student's topic suggestion function.

===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise the tests will not pass on TravisCI.
*Create RSpec file in /spec/features/ folder.
*Use fixtures to create the assignment record and any other records such as participant records in test DB.
*Use Capybara to write functional tests for these three scenarios.
**One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
**One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
**One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
*Create multiple tests to check valid and invalid cases.
<br>

==Design of solution==
To test the functionality of student's suggest topic, we plan to use Capybara to write the test code for each step listed below, covering all three scenarios.
(We wish to add some UI screenshots for each step, for better illustration, but seems the file upload function of this expertiza wiki is available for student user level so far.)

===Prerequisites===
In the project, we assume that an instructor account ''instructor6'' and a student account ''student11'' is already created.
===Flow of suggest topic function===
====Step 1 Use instructor to add a course with topic suggestion enabled====
First step is to login with the instructor account (''instructor6'' here), and then create a course with the '''new public assignment''' function.
We will create the assignment and edit the topic feature to '''enable the topic suggestions''' function for student, where in the UI, it means select the "Allow topic suggestions from students?" checkbox.
Also, to test the second and third scenarios that the student already hold a topic, we will '''add a new topic''' with 1 slot for testing the later two scenarios.
After all above are done, the course just created can be saved to the test database.

In this step, we need to write two functional tests: one is to check whether the course can be added and does the added one have topic suggestion enabled, the other one is to check whether the topic is added by instructor with 1 slot.
[[File:Csc517-final-design-yj-2.png]]

<br>

====Step 2 Add student to the course====
After the course is added, the student (''student11'' for this test project) will be '''added as participants''' to the course.
For UI test, it should be entering "student11" as the participant name with the "participant" choice selected then click "add" button.

In this step, we need to test whether the student, named ''student11'', is added to the course correctly.

[[File:Csc517-final-design-yj-3.png]]

<br>

====Step 3.1 Use student to suggest a new topic without holding any topic====
For the first scenario, which the student does not holding any topic, we should test after login with ''student11'' account and choose the assignment just created by ''instructor6''.
Then, we will '''suggest a topic''' with the choice of "Yes" for the question '''Do you wish to work on this topic?''' and '''submit''' the new topic suggestion.

In this step, we need to write the function test to check whether the new topic is added and the student is willing to work on this topic if it is approved.

[[File:Csc517-final-design-yj-41.png]]

<br>

====Step 3.2 Use student to suggest a new topic holding a topic and wish to switch ====
For the second scenario, we should first let the student login and '''Signup''' the only topic created by the instructor in the Signup sheet.
Then do the same thing as depict in Step 3.1.

In this step, we need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 1 and the max number of slots is 2.
[[File:Csc517-final-design-yj-5.png]]

<br>

====Step 3.3 Use student to suggest a new topic holding a topic and do '''NOT''' wish to switch ====
For the third scenario, we should do the same thing as introduced in Step 3.2, but the only difference is to select the choice of "No" for the question '''Do you wish to work on this topic?'''.

In this step, we also need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 0 now and the max number of slots is 2.

[[File:Csc517-final-design-yj-6.png]]

<br>

====Step 4 Approve/Reject the suggested topic====
The approve/reject functions should also be tested by using the ''instructor6'' account. After login the instructor account, use the assignment '''view suggestions''' function to '''view''' and then '''approve/reject''' the new suggested topic.

In this step, we need to write two function tests: one is to check whether the '''Signup sheet''' does have/not have the suggested topic if it is approved/rejected, the other one is to check whether in the student '''suggest new topics''', the topic suggested by ''student11'' is indeed approved/rejected accordingly.

Note that, this step is the final test step for the case of suggested topic is rejected. The following 3 possible step 5 is for the case the suggested topic is approved.

[[File:Csc517-final-design-yj-9.png]]

<br>

====Step 5.1 Student did not holding any topic before suggestion====
In addition to step 4, since the choice is "Yes" for willing to work on this topic when the student suggested, we will also need to test whether the student is already on the list of the new suggested topic and the number of available slot of the new suggested topic is 0.

<br>

====Step 5.2 Student held a topic but '''NOT''' wish to switch to new suggested topic====
For the student was holding a topic and do not want to switch, we need to write two tests: one is to check whether the student is still enrolled on the previous holding topic, and the other one is to confirm that the available slot of the new topic suggested topic is 1.

[[File:Csc517-final-design-yj-7.png]]

<br>

====Step 5.3 Student held a topic and wish to switch to new suggested topic====
For the student was holding a topic, coupled with the test written for Step 5.1, there is another test need to be written to check whether the slot of the previous held topic is increased by one.

[[File:Csc517-final-design-yj-8.png]]

CSC/ECE 517 Spring 2016 E1624 Compose functional tests for Suggest topics of student functionality

2016-04-15T00:16:27Z

Hguan2: /* Step 3.1 Use student to suggest a new topic without holding any topic */

This wiki page is for the description of changes made under E1624 Final project design assignment for Spring 2016, CSC/ECE 517.

==Problem Statement==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for student's topic suggestion function.

===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise the tests will not pass on TravisCI.
*Create RSpec file in /spec/features/ folder.
*Use fixtures to create the assignment record and any other records such as participant records in test DB.
*Use Capybara to write functional tests for these three scenarios.
**One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
**One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
**One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
*Create multiple tests to check valid and invalid cases.
<br>

==Design of solution==
To test the functionality of student's suggest topic, we plan to use Capybara to write the test code for each step listed below, covering all three scenarios.
(We wish to add some UI screenshots for each step, for better illustration, but seems the file upload function of this expertiza wiki is available for student user level so far.)

===Prerequisites===
In the project, we assume that an instructor account ''instructor6'' and a student account ''student11'' is already created.
===Flow of suggest topic function===
====Step 1 Use instructor to add a course with topic suggestion enabled====
First step is to login with the instructor account (''instructor6'' here), and then create a course with the '''new public assignment''' function.
We will create the assignment and edit the topic feature to '''enable the topic suggestions''' function for student, where in the UI, it means select the "Allow topic suggestions from students?" checkbox.
Also, to test the second and third scenarios that the student already hold a topic, we will '''add a new topic''' with 1 slot for testing the later two scenarios.
After all above are done, the course just created can be saved to the test database.

In this step, we need to write two functional tests: one is to check whether the course can be added and does the added one have topic suggestion enabled, the other one is to check whether the topic is added by instructor with 1 slot.
[[File:Csc517-final-design-yj-2.png]]

<br>

====Step 2 Add student to the course====
After the course is added, the student (''student11'' for this test project) will be '''added as participants''' to the course.
For UI test, it should be entering "student11" as the participant name with the "participant" choice selected then click "add" button.

In this step, we need to test whether the student, named ''student11'', is added to the course correctly.

[[File:Csc517-final-design-yj-3.png]]

<br>

====Step 3.1 Use student to suggest a new topic without holding any topic====
For the first scenario, which the student does not holding any topic, we should test after login with ''student11'' account and choose the assignment just created by ''instructor6''.
Then, we will '''suggest a topic''' with the choice of "Yes" for the question '''Do you wish to work on this topic?''' and '''submit''' the new topic suggestion.

In this step, we need to write the function test to check whether the new topic is added and the student is willing to work on this topic if it is approved.

[[File:Csc517-final-design-yj-41.png]]

<br>

====Step 3.2 Use student to suggest a new topic holding a topic and wish to switch ====
For the second scenario, we should first let the student login and '''Signup''' the only topic created by the instructor in the Signup sheet.
Then do the same thing as depict in Step 3.1.

In this step, we need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 1 and the max number of slots is 2.
[[File:Csc517-final-design-yj-5.png]]

<br>

====Step 3.3 Use student to suggest a new topic holding a topic and do '''NOT''' wish to switch ====
For the third scenario, we should do the same thing as introduced in Step 3.2, but the only difference is to select the choice of "No" for the question '''Do you wish to work on this topic?'''.

In this step, we also need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 0 now and the max number of slots is 2.

[[File:Csc517-final-design-yj-6.png]]

<br>

====Step 4 Approve/Reject the suggested topic====
The approve/reject functions should also be tested by using the ''instructor6'' account. After login the instructor account, use the assignment '''view suggestions''' function to '''view''' and then '''approve/reject''' the new suggested topic.

In this step, we need to write two function tests: one is to check whether the '''Signup sheet''' does have/not have the suggested topic if it is approved/rejected, the other one is to check whether in the student '''suggest new topics''', the topic suggested by ''student11'' is indeed approved/rejected accordingly.

Note that, this step is the final test step for the case of suggested topic is rejected. The following 3 possible step 5 is for the case the suggested topic is approved.
[[File:Csc517-final-design-yj-9.png]]

<br>

====Step 5.1 Student did not holding any topic before suggestion====
In addition to step 4, since the choice is "Yes" for willing to work on this topic when the student suggested, we will also need to test whether the student is already on the list of the new suggested topic and the number of available slot of the new suggested topic is 0.

<br>

====Step 5.2 Student held a topic but '''NOT''' wish to switch to new suggested topic====
For the student was holding a topic and do not want to switch, we need to write two tests: one is to check whether the student is still enrolled on the previous holding topic, and the other one is to confirm that the available slot of the new topic suggested topic is 1.

[[File:Csc517-final-design-yj-7.png]]

<br>

====Step 5.3 Student held a topic and wish to switch to new suggested topic====
For the student was holding a topic, coupled with the test written for Step 5.1, there is another test need to be written to check whether the slot of the previous held topic is increased by one.

[[File:Csc517-final-design-yj-8.png]]

CSC/ECE 517 Spring 2016 E1624 Compose functional tests for Suggest topics of student functionality

2016-04-15T00:16:17Z

Hguan2: /* Step 2 Add student to the course */

This wiki page is for the description of changes made under E1624 Final project design assignment for Spring 2016, CSC/ECE 517.

==Problem Statement==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for student's topic suggestion function.

===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise the tests will not pass on TravisCI.
*Create RSpec file in /spec/features/ folder.
*Use fixtures to create the assignment record and any other records such as participant records in test DB.
*Use Capybara to write functional tests for these three scenarios.
**One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
**One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
**One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
*Create multiple tests to check valid and invalid cases.
<br>

==Design of solution==
To test the functionality of student's suggest topic, we plan to use Capybara to write the test code for each step listed below, covering all three scenarios.
(We wish to add some UI screenshots for each step, for better illustration, but seems the file upload function of this expertiza wiki is available for student user level so far.)

===Prerequisites===
In the project, we assume that an instructor account ''instructor6'' and a student account ''student11'' is already created.
===Flow of suggest topic function===
====Step 1 Use instructor to add a course with topic suggestion enabled====
First step is to login with the instructor account (''instructor6'' here), and then create a course with the '''new public assignment''' function.
We will create the assignment and edit the topic feature to '''enable the topic suggestions''' function for student, where in the UI, it means select the "Allow topic suggestions from students?" checkbox.
Also, to test the second and third scenarios that the student already hold a topic, we will '''add a new topic''' with 1 slot for testing the later two scenarios.
After all above are done, the course just created can be saved to the test database.

In this step, we need to write two functional tests: one is to check whether the course can be added and does the added one have topic suggestion enabled, the other one is to check whether the topic is added by instructor with 1 slot.
[[File:Csc517-final-design-yj-2.png]]

<br>

====Step 2 Add student to the course====
After the course is added, the student (''student11'' for this test project) will be '''added as participants''' to the course.
For UI test, it should be entering "student11" as the participant name with the "participant" choice selected then click "add" button.

In this step, we need to test whether the student, named ''student11'', is added to the course correctly.

[[File:Csc517-final-design-yj-3.png]]

<br>

====Step 3.1 Use student to suggest a new topic without holding any topic====
For the first scenario, which the student does not holding any topic, we should test after login with ''student11'' account and choose the assignment just created by ''instructor6''.
Then, we will '''suggest a topic''' with the choice of "Yes" for the question '''Do you wish to work on this topic?''' and '''submit''' the new topic suggestion.

In this step, we need to write the function test to check whether the new topic is added and the student is willing to work on this topic if it is approved.
[[File:Csc517-final-design-yj-41.png]]

<br>

====Step 3.2 Use student to suggest a new topic holding a topic and wish to switch ====
For the second scenario, we should first let the student login and '''Signup''' the only topic created by the instructor in the Signup sheet.
Then do the same thing as depict in Step 3.1.

In this step, we need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 1 and the max number of slots is 2.
[[File:Csc517-final-design-yj-5.png]]

<br>

====Step 3.3 Use student to suggest a new topic holding a topic and do '''NOT''' wish to switch ====
For the third scenario, we should do the same thing as introduced in Step 3.2, but the only difference is to select the choice of "No" for the question '''Do you wish to work on this topic?'''.

In this step, we also need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 0 now and the max number of slots is 2.

[[File:Csc517-final-design-yj-6.png]]

<br>

====Step 4 Approve/Reject the suggested topic====
The approve/reject functions should also be tested by using the ''instructor6'' account. After login the instructor account, use the assignment '''view suggestions''' function to '''view''' and then '''approve/reject''' the new suggested topic.

In this step, we need to write two function tests: one is to check whether the '''Signup sheet''' does have/not have the suggested topic if it is approved/rejected, the other one is to check whether in the student '''suggest new topics''', the topic suggested by ''student11'' is indeed approved/rejected accordingly.

Note that, this step is the final test step for the case of suggested topic is rejected. The following 3 possible step 5 is for the case the suggested topic is approved.
[[File:Csc517-final-design-yj-9.png]]

<br>

====Step 5.1 Student did not holding any topic before suggestion====
In addition to step 4, since the choice is "Yes" for willing to work on this topic when the student suggested, we will also need to test whether the student is already on the list of the new suggested topic and the number of available slot of the new suggested topic is 0.

<br>

====Step 5.2 Student held a topic but '''NOT''' wish to switch to new suggested topic====
For the student was holding a topic and do not want to switch, we need to write two tests: one is to check whether the student is still enrolled on the previous holding topic, and the other one is to confirm that the available slot of the new topic suggested topic is 1.

[[File:Csc517-final-design-yj-7.png]]

<br>

====Step 5.3 Student held a topic and wish to switch to new suggested topic====
For the student was holding a topic, coupled with the test written for Step 5.1, there is another test need to be written to check whether the slot of the previous held topic is increased by one.

[[File:Csc517-final-design-yj-8.png]]

File:Screen Shot 2016-04-03 at 5.06.21 PM.png

2016-04-05T16:19:26Z

Hguan2:

File:Student login page.png

2016-04-05T16:13:46Z

Hguan2:

CSC/ECE 517 Spring 2016 E1624 Compose functional tests for Suggest topics of student functionality

2016-04-05T16:11:35Z

Hguan2: /* Prerequisites */

This wiki page is for the description of changes made under E1624 Final project design assignment for Spring 2016, CSC/ECE 517.

==Problem Statement==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for student's topic suggestion function.

===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise the tests will not pass on TravisCI.
*Create RSpec file in /spec/features/ folder.
*Use fixtures to create the assignment record and any other records such as participant records in test DB.
*Use Capybara to write functional tests for these three scenarios.
**One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
**One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
**One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
*Create multiple tests to check valid and invalid cases.
<br>

==Design of solution==
To test the functionality of student's suggest topic, we plan to use Capybara to write the test code for each step listed below, covering all three scenarios.
(We wish to add some UI screenshots for each step, for better illustration, but seems the file upload function of this expertiza wiki is available for student user level so far.)

===Prerequisites===
In the project, we assume that an instructor account ''instructor6'' and a student account ''student11'' is already created.

===Flow of suggest topic function===
====Step 1 Use instructor to add a course with topic suggestion enabled====
First step is to login with the instructor account (''instructor6'' here), and then create a course with the '''new public assignment''' function.
We will create the assignment and edit the topic feature to '''enable the topic suggestions''' function for student, where in the UI, it means select the "Allow topic suggestions from students?" checkbox.
Also, to test the second and third scenarios that the student already hold a topic, we will '''add a new topic''' with 1 slot for testing the later two scenarios.
After all above are done, the course just created can be saved to the test database.

In this step, we need to write two functional tests: one is to check whether the course can be added and does the added one have topic suggestion enabled, the other one is to check whether the topic is added by instructor with 1 slot.

====Step 2 Add student to the course====
After the course is added, the student (''student11'' for this test project) will be '''added as participants''' to the course.
For UI test, it should be entering "student11" as the participant name with the "participant" choice selected then click "add" button.

In this step, we need to test whether the student, named ''student11'', is added to the course correctly.

====Step 3.1 Use student to suggest a new topic without holding any topic====
For the first scenario, which the student does not holding any topic, we should test after login with ''student11'' account and choose the assignment just created by ''instructor6''.
Then, we will '''suggest a topic''' with the choice of "Yes" for the question '''Do you wish to work on this topic?''' and '''submit''' the new topic suggestion.

In this step, we need to write the function test to check whether the new topic is added and the student is willing to work on this topic if it is approved.

====Step 3.2 Use student to suggest a new topic holding a topic and wish to switch ====
For the second scenario, we should first let the student login and '''Signup''' the only topic created by the instructor in the Signup sheet.
Then do the same thing as depict in Step 3.1.

In this step, we need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 1 and the max number of slots is 2.

====Step 3.3 Use student to suggest a new topic holding a topic and do NOT wish to switch ====
For the third scenario, we should do the same thing as introduced in Step 3.2, but the only difference is to select the choice of "No" for the question '''Do you wish to work on this topic?'''.

In this step, we also need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 0 now and the max number of slots is 2.

====Step 4 Approve/Reject the suggested topic====
The approve/reject functions should also be tested by using the ''instructor6'' account. After login the instructor account, use the assignment '''view suggestions''' function to '''view''' and then '''approve/reject''' the new suggested topic.

In this step, we need to write two function tests: one is to check whether the '''Signup sheet''' does have/not have the suggested topic if it is approved/rejected, the other one is to check whether in the student '''suggest new topics''', the topic suggested by ''student11'' is indeed approved/rejected accordingly.

Note that, this step is the final test step for the case of suggested topic is rejected. The following 3 possible step 5 is for the case the suggested topic is approved.

====Step 5.1 Student did not holding any topic before suggestion====
In addition to step 4, since the choice is "Yes" for willing to work on this topic when the student suggested, we will also need to test whether the student is already on the list of the new suggested topic and the number of available slot of the new suggested topic is 0.

====Step 5.2 Student held a topic and wish to switch to new suggested topic====
For the student was holding a topic, coupled with the test written for Step 5.1, there is another test need to be written to check whether the slot of the previous held topic is increased by one.

====Step 5.3 Student held a topic but NOT wish to switch to new suggested topic====
For the student was holding a topic and do not want to switch, we need to write two tests: one is to check whether the student is still enrolled on the previous holding topic, and the other one is to confirm that the available slot of the new topic suggested topic is 1.

CSC/ECE 517 Spring 2016 E1624 Compose functional tests for Suggest topics of student functionality

2016-04-05T16:09:44Z

Hguan2: /* Design of solution */

This wiki page is for the description of changes made under E1624 Final project design assignment for Spring 2016, CSC/ECE 517.

==Problem Statement==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for student's topic suggestion function.

===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise the tests will not pass on TravisCI.
*Create RSpec file in /spec/features/ folder.
*Use fixtures to create the assignment record and any other records such as participant records in test DB.
*Use Capybara to write functional tests for these three scenarios.
**One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
**One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
**One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
*Create multiple tests to check valid and invalid cases.
<br>

==Design of solution==
To test the functionality of student's suggest topic, we plan to use Capybara to write the test code for each step listed below, covering all three scenarios.
(We wish to add some UI screenshots for each step, for better illustration, but seems the file upload function of this expertiza wiki is available for student user level so far.)

===Prerequisites===
In the project, we assume that an instructor account ''instructor6'' and a student account ''student11'' is already created.
[[File:Example.jpg]]

===Flow of suggest topic function===
====Step 1 Use instructor to add a course with topic suggestion enabled====
First step is to login with the instructor account (''instructor6'' here), and then create a course with the '''new public assignment''' function.
We will create the assignment and edit the topic feature to '''enable the topic suggestions''' function for student, where in the UI, it means select the "Allow topic suggestions from students?" checkbox.
Also, to test the second and third scenarios that the student already hold a topic, we will '''add a new topic''' with 1 slot for testing the later two scenarios.
After all above are done, the course just created can be saved to the test database.

In this step, we need to write two functional tests: one is to check whether the course can be added and does the added one have topic suggestion enabled, the other one is to check whether the topic is added by instructor with 1 slot.

====Step 2 Add student to the course====
After the course is added, the student (''student11'' for this test project) will be '''added as participants''' to the course.
For UI test, it should be entering "student11" as the participant name with the "participant" choice selected then click "add" button.

In this step, we need to test whether the student, named ''student11'', is added to the course correctly.

====Step 3.1 Use student to suggest a new topic without holding any topic====
For the first scenario, which the student does not holding any topic, we should test after login with ''student11'' account and choose the assignment just created by ''instructor6''.
Then, we will '''suggest a topic''' with the choice of "Yes" for the question '''Do you wish to work on this topic?''' and '''submit''' the new topic suggestion.

In this step, we need to write the function test to check whether the new topic is added and the student is willing to work on this topic if it is approved.

====Step 3.2 Use student to suggest a new topic holding a topic and wish to switch ====
For the second scenario, we should first let the student login and '''Signup''' the only topic created by the instructor in the Signup sheet.
Then do the same thing as depict in Step 3.1.

In this step, we need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 1 and the max number of slots is 2.

====Step 3.3 Use student to suggest a new topic holding a topic and do NOT wish to switch ====
For the third scenario, we should do the same thing as introduced in Step 3.2, but the only difference is to select the choice of "No" for the question '''Do you wish to work on this topic?'''.

In this step, we also need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 0 now and the max number of slots is 2.

====Step 4 Approve/Reject the suggested topic====
The approve/reject functions should also be tested by using the ''instructor6'' account. After login the instructor account, use the assignment '''view suggestions''' function to '''view''' and then '''approve/reject''' the new suggested topic.

In this step, we need to write two function tests: one is to check whether the '''Signup sheet''' does have/not have the suggested topic if it is approved/rejected, the other one is to check whether in the student '''suggest new topics''', the topic suggested by ''student11'' is indeed approved/rejected accordingly.

Note that, this step is the final test step for the case of suggested topic is rejected. The following 3 possible step 5 is for the case the suggested topic is approved.

====Step 5.1 Student did not holding any topic before suggestion====
In addition to step 4, since the choice is "Yes" for willing to work on this topic when the student suggested, we will also need to test whether the student is already on the list of the new suggested topic and the number of available slot of the new suggested topic is 0.

====Step 5.2 Student held a topic and wish to switch to new suggested topic====
For the student was holding a topic, coupled with the test written for Step 5.1, there is another test need to be written to check whether the slot of the previous held topic is increased by one.

====Step 5.3 Student held a topic but NOT wish to switch to new suggested topic====
For the student was holding a topic and do not want to switch, we need to write two tests: one is to check whether the student is still enrolled on the previous holding topic, and the other one is to confirm that the available slot of the new topic suggested topic is 1.

CSC/ECE 517 Spring 2016 E1624 Compose functional tests for Suggest topics of student functionality

2016-04-05T15:58:00Z

Hguan2: /* What needs to be done */

This wiki page is for the description of changes made under E1624 Final project design assignment for Spring 2016, CSC/ECE 517.

==Problem Statement==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for student's topic suggestion function.

===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise the tests will not pass on TravisCI.
*Create RSpec file in /spec/features/ folder.
*Use fixtures to create the assignment record and any other records such as participant records in test DB.
*Use Capybara to write functional tests for these three scenarios.
**One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
**One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
**One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
*Create multiple tests to check valid and invalid cases.
<br>

==Design of solution==
To test the functionality of student's suggest topic, we plan to use Capybara to write the test code for each step listed below, covering all three scenarios.
In the project, we assume that an instructor account ''instructor6'' and a student account ''student11'' is already created.
(We wish to add some UI screenshots for each step, for better illustration, but seems the file upload function of this expertiza wiki is available for student user level so far.)

===Flow of suggest topic function===
====Step 1 Use instructor to add a course with topic suggestion enabled====
First step is to login with the instructor account (''instructor6'' here), and then create a course with the '''new public assignment''' function.
We will create the assignment and edit the topic feature to '''enable the topic suggestions''' function for student, where in the UI, it means select the "Allow topic suggestions from students?" checkbox.
Also, to test the second and third scenarios that the student already hold a topic, we will '''add a new topic''' with 1 slot for testing the later two scenarios.
After all above are done, the course just created can be saved to the test database.

In this step, we need to write two functional tests: one is to check whether the course can be added and does the added one have topic suggestion enabled, the other one is to check whether the topic is added by instructor with 1 slot.

====Step 2 Add student to the course====
After the course is added, the student (''student11'' for this test project) will be '''added as participants''' to the course.
For UI test, it should be entering "student11" as the participant name with the "participant" choice selected then click "add" button.

In this step, we need to test whether the student, named ''student11'', is added to the course correctly.

====Step 3.1 Use student to suggest a new topic without holding any topic====
For the first scenario, which the student does not holding any topic, we should test after login with ''student11'' account and choose the assignment just created by ''instructor6''.
Then, we will '''suggest a topic''' with the choice of "Yes" for the question '''Do you wish to work on this topic?''' and '''submit''' the new topic suggestion.

In this step, we need to write the function test to check whether the new topic is added and the student is willing to work on this topic if it is approved.

====Step 3.2 Use student to suggest a new topic holding a topic and wish to switch ====
For the second scenario, we should first let the student login and '''Signup''' the only topic created by the instructor in the Signup sheet.
Then do the same thing as depict in Step 3.1.

In this step, we need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 1 and the max number of slots is 2.

====Step 3.3 Use student to suggest a new topic holding a topic and do NOT wish to switch ====
For the third scenario, we should do the same thing as introduced in Step 3.2, but the only difference is to select the choice of "No" for the question '''Do you wish to work on this topic?'''.

In this step, we also need to write two function tests: one is to check whether the student is already on the student list the topic, and the other one is to check whether the topic's available slots of the topic is 0 now and the max number of slots is 2.

====Step 4 Approve/Reject the suggested topic====
The approve/reject functions should also be tested by using the ''instructor6'' account. After login the instructor account, use the assignment '''view suggestions''' function to '''view''' and then '''approve/reject''' the new suggested topic.

In this step, we need to write two function tests: one is to check whether the '''Signup sheet''' does have/not have the suggested topic if it is approved/rejected, the other one is to check whether in the student '''suggest new topics''', the topic suggested by ''student11'' is indeed approved/rejected accordingly.

Note that, this step is the final test step for the case of suggested topic is rejected. The following 3 possible step 5 is for the case the suggested topic is approved.

====Step 5.1 Student did not holding any topic before suggestion====
In addition to step 4, since the choice is "Yes" for willing to work on this topic when the student suggested, we will also need to test whether the student is already on the list of the new suggested topic and the number of available slot of the new suggested topic is 0.

====Step 5.2 Student held a topic and wish to switch to new suggested topic====
For the student was holding a topic, coupled with the test written for Step 5.1, there is another test need to be written to check whether the slot of the previous held topic is increased by one.

====Step 5.3 Student held a topic but NOT wish to switch to new suggested topic====
For the student was holding a topic and do not want to switch, we need to write two tests: one is to check whether the student is still enrolled on the previous holding topic, and the other one is to confirm that the available slot of the new topic suggested topic is 1.

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-04-04T01:35:44Z

Hguan2: /* Unit-tests */

This wiki page is for the description of changes made under E1608 OSS assignment for Spring 2016, CSC/ECE 517. The assignment task is to refactor & write unit tests for [question_type].rb (eg. criterion.rb).

== Problem Statement ==
===Files related===
Four models is related: criterion.rb, scale.rb, checkbox.rb, questionnaire_header.rb, upload_file.rb. There are 4 methods “edit”, “view_question_text”, “complete” and “view_completed_question” correspond to different views.

*edit ~> when instructor add/edit new questions
*view ~> when instructor view existed questions
*complete ~> when students do peer reviews
*view_completed_question ~> when student view existed peer reviews

===Expertiza question types inheritance hierarchy===

*Choice question
**Scored question
***Scale
***Criterion
**Unscored question
***Dropdown
***CheckBox
*TextResponse
**TextArea
**TextField
*UploadFile

===Files problem===

There are some issues in each file, such as security, complexity, duplication, etc. And currently there is no unit tests for [question_type].rb.

===Our contribution===
*Refactor these [question_type].rb files and fix issues.
*Keep the inputs and outputs of these methods (edit, view, complete, view_completed_question) the same as before.
*Write unit tests for [question_type].rb listed above.
*Create RSpec files for each question type in /spec/models/ folder
*Create multiple tests to check valid and invalid cases, such as input including special character double quote (“”).

<br>
==Refactor==
===Criterion.rb===
* Method has too many lines: Line 35 - 158 [106/30]
Wrap the specific code into different instance methods.
* Cyclomatic complexity for complete is too high: Line 35 - 158 [28/6]
Wrap the code into different instance methods to reduce cyclomatic complexity
<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
if self.size.nil?
cols = '70'
rows = '1'
else
cols = self.size.split(',')[0]
rows = self.size.split(',')[1]
end
html = '<li><div><label for="responses_' +count.to_s+ '">' +self.txt+ "</label></div>"
#show advice for each criterion question
question_advices = QuestionAdvice.where(question_id: self.id).sort_by { |advice| advice.id }
advice_total_length = 0
question_advices.each do |question_advice|
if question_advice.advice && !question_advice.advice == ""
advice_total_length += question_advice.advice.length
end
end
if question_advices.length > 0 and advice_total_length > 0
html = complete_show_advice(self, html)
question_advices.reverse.each_with_index do |question_advice, index|
html += '<a id="changeScore_>' + self.id.to_s + '" onclick="changeScore(' + count.to_s + ',' + index.to_s + ')">'
html += (question_advices.length - index).to_s + ' - ' + question_advice.advice + '</a><br/>'
html += '<script>'
html += 'function changeScore(i, j) {'
html += 'var elem = jQuery("#responses_" + i.toString() + "_score");'
html += 'var opts = elem.children("option").length;'
html += 'elem.val((opts - j - 1).toString());}'
html += '</script>'
end
html += '</div>'
end
if dropdown_or_scale == 'dropdown'
## code added to reduce Cyclomatic Complexity
html = complete_drop_down(self, html, count, answer, questionnaire_min, questionnaire_max)
elsif dropdown_or_scale == 'scale'
html = complete_scale(self, html, count, answer, questionnaire_min, questionnaire_max)
end
html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 20 - 32 (mass = 89)
Also found in app/models/scale.rb:17…28. The following method is removed from subclass: criterion and added to their superclass: scaled_question
<pre>
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
Html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 135 - 139 (mass = 50)
Also found in app/models/scale.rb:50…54. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location Line 13 - 14 (mass = 40)
Also found in app/models/scale.rb:10…11. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 1 other location Line 103 - 105 (mass = 26)
Also found in app/models/criterion.rb:107…110. Wrap the duplicated code into an instance method
<pre>
def complete_drop_down_label_config(html, label)
html += j.to_s
html += "-" + label if label && label.length>0
html += "</option>"
end
</pre>
* Similar code found in 2 other locations Line 152 - 153 (mass = 22)
Also found in app/models/criterion.rb:115…116, app/models/text_area.rb:12…13. Wrap the duplicated code into an instance method
<pre>
def complete_answer_comment(count, html, answer)
html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
html += answer.comments if !answer.nil?
end
</pre>
* Similar code found in 3 other locations: Line 130 - 134 (mass = 18)
Also found in app/models/criterion.rb:145…149, app/models/scale.rb:45…49, app/models/scale.rb:60…64.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Scale.rb===
* Cyclomatic complexity for complete is too high. Method has too many lines

<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max)
html = self.txt + '<br>'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += 'value="'+answer.answer.to_s+'"' if !answer.nil?
html += '>'
html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'

html += '<table>'
html += '<tr><td width="10%"></td>'
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><label>' +j.to_s+ '</label></td>'
end
html += '<td width="10%"></td></tr><tr>'

html = complete_label(self.min_label, html)
html = complete_questionnaire_min_to_questionnaire_max(self, html, answer, questionnaire_min, questionnaire_max)

html += '<script>jQuery("input[name=Radio_' +self.id.to_s+ ']:radio").change(function() {'
html += 'var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'var checked_value = jQuery("input[name=Radio_' +self.id.to_s+ ']:checked").val();'
html += 'response_score.val(checked_value);});</script>'
html = complete_label(self.max_label, html)

html += '<td width="10%"></td></tr></table>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 17-28
app/models/criterion.rb:20…32, def view_question_text.
The following method is removed from subclass: scale and added to their superclass: scaled_question.

<pre>
#This method returns what to display if an instructor (etc.) is viewing a questionnaire
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 50-54
app/models/criterion.rb:135…139. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question.
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location: line 10-11
app/models/criterion.rb:13…14. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 3 other locations: line 60-64
app/models/criterion.rb:130…134, app/models/criterion.rb:145…149, app/models/scale.rb:45…49.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Checkbox.rb===
* Method has too many lines.
By moving codes to private methods outside this method, this problem can be fixed together with the following one. Here is the new complete method together with two additional private methods: hasAnswer(html, answer) and nextQuestionTail(html, next_question). The source codes are listed as below.
<pre>
def complete(count, answer=nil)
curr_question = Question.find(self.id)
prev_question = Question.where("seq < ?", curr_question.seq).order(:seq).last
next_question = Question.where("seq > ?", curr_question.seq).order(:seq).first
html = ''
if prev_question.type == 'ColumnHeader'
html = '<td style="padding: 15px;">'
end

html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += hasAnswer(html , answer)
html += '>'
html += '<input id="responses_' +count.to_s+ '_checkbox" type="checkbox" onchange="checkbox' +count.to_s+ 'Changed()"'
html += 'checked="checked"' if !answer.nil? and answer.answer == 1
html += '>'
html += '<label for="responses_' +count.to_s+ '">' +self.txt+ '</label>'

html += '<script>function checkbox' +count.to_s+ 'Changed() {'
html += ' var checkbox = jQuery("#responses_' +count.to_s+ '_checkbox");'
html += ' var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'

html = nextQuestionTail(html, next_question)
html.html_safe
end

#YJ private for complete()
def hasAnswer(html, answer)
if !answer.nil? and answer.answer == 1
html += 'value="1"'
else
html += 'value="0"'
end
return html
end

def nextQuestionTail(html, next_q)
if next_question.type == 'ColumnHeader'
html += '</td></tr>'
elsif next_question.type == 'SectionHeader' or next_question.type == 'TableHeader'
html += '</td></tr></table><br/>'
else
html += '<BR/>'
end
return html
end
</pre>
* Cyclomatic complexity for complete is too high.
This problem can be solved by moving branches outside to other private methods. See source code above.
* Similar codes in edit method are found in 2 other locations.
(questionnaire_header.rb and upload_file.rb)
Such code duplication can be eliminated by moving the identical part of the similar edit method to a new function, named edit_prefix(html, count) to their common superclass, which is Question (question.rb).
Here is the source code of the added edit_prefix method in question.rb:
<pre>
def edit_prefix(self, html)
html ='<tr>'
html+='<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' +ob.id.to_s+ '">Remove</a></td>'
html+='<td><input size="6" value="'+ob.seq.to_s+'" name="question['+ob.id.to_s+'][seq]" id="question_'+ob.id.to_s+'_seq" type="text"></td>'
html+='<td><textarea cols="50" rows="1" name="question['+ob.id.to_s+'][txt]" id="question_'+ob.id.to_s+'_txt">'+ob.txt+'</textarea></td>'
html+='<td><input size="10" disabled="disabled" value="'+ob.type+'" name="question['+ob.id.to_s+'][type]" id="question_'+ob.id.to_s+'_type" type="text">''</td>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def edit(count)
html = edit_prefix(self, html)
html+='<td></td>'
html+='</tr>'
html.html_safe
end
</pre>
* Similar codes in view_question_text method are found in 4 other locations.
(dropdown.rb, questionnaire_header.rb, text_response.rb, upload_file.rb)
The solution to this problem is the same as above one, below is the function added in the most common superclass, which is Question, that contains the common parts of the codes found in the view_question_text methods in all five classes.
<pre>
def view_qt_prefix(ob, html)
html = '<TR><TD align="left"> '+ob.txt+ ' </TD>'
html += '<TD align="left">'+ob.type+'</TD>'
html += '<td align="center">'+ob.weight.to_s+'</TD>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def view_question_text
html = view_qt_prefix(ob, html)
html += '<TD align="center">Checked/Unchecked</TD>'
html += '</TR>'
html.html_safe
end
</pre>

===Questionnaire_header.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

===Upload_file.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

<br>

==Unit-tests==
One contribution is to write unite test for four question types. For each of the four required question types:
*criterion.rb,
*scale.rb,
*checkbox.rb,
*upload_file.rb,
there are four unit tests for the following four functions:
*''edit'',
*''complete'',
*''view_question_text'',
*''view_complete_question_text''.

These four functions are tested since they are the only methods that the question types class can perform.

The output of those four functions is HTML format string. We test if the output string is matched with the expected given certain conditions. Here are the spec files git hub links:
*[https://github.com/schen35/expertiza/blob/master/spec/models/criterion_spec.rb criterion_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/scale_spec.rb scale_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/checkbox_spec.rb checkbox_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/upload_file_spec.rb upload_file_spec.rb].

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-04-04T01:35:25Z

Hguan2: /* Unit-tests */

This wiki page is for the description of changes made under E1608 OSS assignment for Spring 2016, CSC/ECE 517. The assignment task is to refactor & write unit tests for [question_type].rb (eg. criterion.rb).

== Problem Statement ==
===Files related===
Four models is related: criterion.rb, scale.rb, checkbox.rb, questionnaire_header.rb, upload_file.rb. There are 4 methods “edit”, “view_question_text”, “complete” and “view_completed_question” correspond to different views.

*edit ~> when instructor add/edit new questions
*view ~> when instructor view existed questions
*complete ~> when students do peer reviews
*view_completed_question ~> when student view existed peer reviews

===Expertiza question types inheritance hierarchy===

*Choice question
**Scored question
***Scale
***Criterion
**Unscored question
***Dropdown
***CheckBox
*TextResponse
**TextArea
**TextField
*UploadFile

===Files problem===

There are some issues in each file, such as security, complexity, duplication, etc. And currently there is no unit tests for [question_type].rb.

===Our contribution===
*Refactor these [question_type].rb files and fix issues.
*Keep the inputs and outputs of these methods (edit, view, complete, view_completed_question) the same as before.
*Write unit tests for [question_type].rb listed above.
*Create RSpec files for each question type in /spec/models/ folder
*Create multiple tests to check valid and invalid cases, such as input including special character double quote (“”).

<br>
==Refactor==
===Criterion.rb===
* Method has too many lines: Line 35 - 158 [106/30]
Wrap the specific code into different instance methods.
* Cyclomatic complexity for complete is too high: Line 35 - 158 [28/6]
Wrap the code into different instance methods to reduce cyclomatic complexity
<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
if self.size.nil?
cols = '70'
rows = '1'
else
cols = self.size.split(',')[0]
rows = self.size.split(',')[1]
end
html = '<li><div><label for="responses_' +count.to_s+ '">' +self.txt+ "</label></div>"
#show advice for each criterion question
question_advices = QuestionAdvice.where(question_id: self.id).sort_by { |advice| advice.id }
advice_total_length = 0
question_advices.each do |question_advice|
if question_advice.advice && !question_advice.advice == ""
advice_total_length += question_advice.advice.length
end
end
if question_advices.length > 0 and advice_total_length > 0
html = complete_show_advice(self, html)
question_advices.reverse.each_with_index do |question_advice, index|
html += '<a id="changeScore_>' + self.id.to_s + '" onclick="changeScore(' + count.to_s + ',' + index.to_s + ')">'
html += (question_advices.length - index).to_s + ' - ' + question_advice.advice + '</a><br/>'
html += '<script>'
html += 'function changeScore(i, j) {'
html += 'var elem = jQuery("#responses_" + i.toString() + "_score");'
html += 'var opts = elem.children("option").length;'
html += 'elem.val((opts - j - 1).toString());}'
html += '</script>'
end
html += '</div>'
end
if dropdown_or_scale == 'dropdown'
## code added to reduce Cyclomatic Complexity
html = complete_drop_down(self, html, count, answer, questionnaire_min, questionnaire_max)
elsif dropdown_or_scale == 'scale'
html = complete_scale(self, html, count, answer, questionnaire_min, questionnaire_max)
end
html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 20 - 32 (mass = 89)
Also found in app/models/scale.rb:17…28. The following method is removed from subclass: criterion and added to their superclass: scaled_question
<pre>
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
Html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 135 - 139 (mass = 50)
Also found in app/models/scale.rb:50…54. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location Line 13 - 14 (mass = 40)
Also found in app/models/scale.rb:10…11. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 1 other location Line 103 - 105 (mass = 26)
Also found in app/models/criterion.rb:107…110. Wrap the duplicated code into an instance method
<pre>
def complete_drop_down_label_config(html, label)
html += j.to_s
html += "-" + label if label && label.length>0
html += "</option>"
end
</pre>
* Similar code found in 2 other locations Line 152 - 153 (mass = 22)
Also found in app/models/criterion.rb:115…116, app/models/text_area.rb:12…13. Wrap the duplicated code into an instance method
<pre>
def complete_answer_comment(count, html, answer)
html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
html += answer.comments if !answer.nil?
end
</pre>
* Similar code found in 3 other locations: Line 130 - 134 (mass = 18)
Also found in app/models/criterion.rb:145…149, app/models/scale.rb:45…49, app/models/scale.rb:60…64.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Scale.rb===
* Cyclomatic complexity for complete is too high. Method has too many lines

<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max)
html = self.txt + '<br>'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += 'value="'+answer.answer.to_s+'"' if !answer.nil?
html += '>'
html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'

html += '<table>'
html += '<tr><td width="10%"></td>'
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><label>' +j.to_s+ '</label></td>'
end
html += '<td width="10%"></td></tr><tr>'

html = complete_label(self.min_label, html)
html = complete_questionnaire_min_to_questionnaire_max(self, html, answer, questionnaire_min, questionnaire_max)

html += '<script>jQuery("input[name=Radio_' +self.id.to_s+ ']:radio").change(function() {'
html += 'var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'var checked_value = jQuery("input[name=Radio_' +self.id.to_s+ ']:checked").val();'
html += 'response_score.val(checked_value);});</script>'
html = complete_label(self.max_label, html)

html += '<td width="10%"></td></tr></table>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 17-28
app/models/criterion.rb:20…32, def view_question_text.
The following method is removed from subclass: scale and added to their superclass: scaled_question.

<pre>
#This method returns what to display if an instructor (etc.) is viewing a questionnaire
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 50-54
app/models/criterion.rb:135…139. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question.
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location: line 10-11
app/models/criterion.rb:13…14. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 3 other locations: line 60-64
app/models/criterion.rb:130…134, app/models/criterion.rb:145…149, app/models/scale.rb:45…49.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Checkbox.rb===
* Method has too many lines.
By moving codes to private methods outside this method, this problem can be fixed together with the following one. Here is the new complete method together with two additional private methods: hasAnswer(html, answer) and nextQuestionTail(html, next_question). The source codes are listed as below.
<pre>
def complete(count, answer=nil)
curr_question = Question.find(self.id)
prev_question = Question.where("seq < ?", curr_question.seq).order(:seq).last
next_question = Question.where("seq > ?", curr_question.seq).order(:seq).first
html = ''
if prev_question.type == 'ColumnHeader'
html = '<td style="padding: 15px;">'
end

html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += hasAnswer(html , answer)
html += '>'
html += '<input id="responses_' +count.to_s+ '_checkbox" type="checkbox" onchange="checkbox' +count.to_s+ 'Changed()"'
html += 'checked="checked"' if !answer.nil? and answer.answer == 1
html += '>'
html += '<label for="responses_' +count.to_s+ '">' +self.txt+ '</label>'

html += '<script>function checkbox' +count.to_s+ 'Changed() {'
html += ' var checkbox = jQuery("#responses_' +count.to_s+ '_checkbox");'
html += ' var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'

html = nextQuestionTail(html, next_question)
html.html_safe
end

#YJ private for complete()
def hasAnswer(html, answer)
if !answer.nil? and answer.answer == 1
html += 'value="1"'
else
html += 'value="0"'
end
return html
end

def nextQuestionTail(html, next_q)
if next_question.type == 'ColumnHeader'
html += '</td></tr>'
elsif next_question.type == 'SectionHeader' or next_question.type == 'TableHeader'
html += '</td></tr></table><br/>'
else
html += '<BR/>'
end
return html
end
</pre>
* Cyclomatic complexity for complete is too high.
This problem can be solved by moving branches outside to other private methods. See source code above.
* Similar codes in edit method are found in 2 other locations.
(questionnaire_header.rb and upload_file.rb)
Such code duplication can be eliminated by moving the identical part of the similar edit method to a new function, named edit_prefix(html, count) to their common superclass, which is Question (question.rb).
Here is the source code of the added edit_prefix method in question.rb:
<pre>
def edit_prefix(self, html)
html ='<tr>'
html+='<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' +ob.id.to_s+ '">Remove</a></td>'
html+='<td><input size="6" value="'+ob.seq.to_s+'" name="question['+ob.id.to_s+'][seq]" id="question_'+ob.id.to_s+'_seq" type="text"></td>'
html+='<td><textarea cols="50" rows="1" name="question['+ob.id.to_s+'][txt]" id="question_'+ob.id.to_s+'_txt">'+ob.txt+'</textarea></td>'
html+='<td><input size="10" disabled="disabled" value="'+ob.type+'" name="question['+ob.id.to_s+'][type]" id="question_'+ob.id.to_s+'_type" type="text">''</td>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def edit(count)
html = edit_prefix(self, html)
html+='<td></td>'
html+='</tr>'
html.html_safe
end
</pre>
* Similar codes in view_question_text method are found in 4 other locations.
(dropdown.rb, questionnaire_header.rb, text_response.rb, upload_file.rb)
The solution to this problem is the same as above one, below is the function added in the most common superclass, which is Question, that contains the common parts of the codes found in the view_question_text methods in all five classes.
<pre>
def view_qt_prefix(ob, html)
html = '<TR><TD align="left"> '+ob.txt+ ' </TD>'
html += '<TD align="left">'+ob.type+'</TD>'
html += '<td align="center">'+ob.weight.to_s+'</TD>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def view_question_text
html = view_qt_prefix(ob, html)
html += '<TD align="center">Checked/Unchecked</TD>'
html += '</TR>'
html.html_safe
end
</pre>

===Questionnaire_header.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

===Upload_file.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

<br>

==Unit-tests==
One contribution is to write unite test for four question types. For each of the four required four question types:
*criterion.rb,
*scale.rb,
*checkbox.rb,
*upload_file.rb,
there are four unit tests for the following four functions:
*''edit'',
*''complete'',
*''view_question_text'',
*''view_complete_question_text''.

These four functions are tested since they are the only methods that the question types class can perform.

The output of those four functions is HTML format string. We test if the output string is matched with the expected given certain conditions. Here are the spec files git hub links:
*[https://github.com/schen35/expertiza/blob/master/spec/models/criterion_spec.rb criterion_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/scale_spec.rb scale_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/checkbox_spec.rb checkbox_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/upload_file_spec.rb upload_file_spec.rb].

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-04-03T20:03:03Z

Hguan2: /* Unit-tests */

This wiki page is for the description of changes made under E1608 OSS assignment for Spring 2016, CSC/ECE 517. The assignment task is to refactor & write unit tests for [question_type].rb (eg. criterion.rb).

== Problem Statement ==
===Files related===
Four models is related: criterion.rb, scale.rb, checkbox.rb, questionnaire_header.rb, upload_file.rb. There are 4 methods “edit”, “view_question_text”, “complete” and “view_completed_question” correspond to different views.

*edit ~> when instructor add/edit new questions
*view ~> when instructor view existed questions
*complete ~> when students do peer reviews
*view_completed_question ~> when student view existed peer reviews

===Expertiza question types inheritance hierarchy===

*Choice question
**Scored question
***Scale
***Criterion
**Unscored question
***Dropdown
***CheckBox
*TextResponse
**TextArea
**TextField
*UploadFile

===Files problem===

There are some issues in each file, such as security, complexity, duplication, etc. And currently there is no unit tests for [question_type].rb.

===Our contribution===
*Refactor these [question_type].rb files and fix issues.
*Keep the inputs and outputs of these methods (edit, view, complete, view_completed_question) the same as before.
*Write unit tests for [question_type].rb listed above.
*Create RSpec files for each question type in /spec/models/ folder
*Create multiple tests to check valid and invalid cases, such as input including special character double quote (“”).

<br>
==Refactor==
===Criterion.rb===
* Method has too many lines: Line 35 - 158 [106/30]
Wrap the specific code into different instance methods.
* Cyclomatic complexity for complete is too high: Line 35 - 158 [28/6]
Wrap the code into different instance methods to reduce cyclomatic complexity
<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
if self.size.nil?
cols = '70'
rows = '1'
else
cols = self.size.split(',')[0]
rows = self.size.split(',')[1]
end
html = '<li><div><label for="responses_' +count.to_s+ '">' +self.txt+ "</label></div>"
#show advice for each criterion question
question_advices = QuestionAdvice.where(question_id: self.id).sort_by { |advice| advice.id }
advice_total_length = 0
question_advices.each do |question_advice|
if question_advice.advice && !question_advice.advice == ""
advice_total_length += question_advice.advice.length
end
end
if question_advices.length > 0 and advice_total_length > 0
html = complete_show_advice(self, html)
question_advices.reverse.each_with_index do |question_advice, index|
html += '<a id="changeScore_>' + self.id.to_s + '" onclick="changeScore(' + count.to_s + ',' + index.to_s + ')">'
html += (question_advices.length - index).to_s + ' - ' + question_advice.advice + '</a><br/>'
html += '<script>'
html += 'function changeScore(i, j) {'
html += 'var elem = jQuery("#responses_" + i.toString() + "_score");'
html += 'var opts = elem.children("option").length;'
html += 'elem.val((opts - j - 1).toString());}'
html += '</script>'
end
html += '</div>'
end
if dropdown_or_scale == 'dropdown'
## code added to reduce Cyclomatic Complexity
html = complete_drop_down(self, html, count, answer, questionnaire_min, questionnaire_max)
elsif dropdown_or_scale == 'scale'
html = complete_scale(self, html, count, answer, questionnaire_min, questionnaire_max)
end
html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 20 - 32 (mass = 89)
Also found in app/models/scale.rb:17…28. The following method is removed from subclass: criterion and added to their superclass: scaled_question
<pre>
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
Html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 135 - 139 (mass = 50)
Also found in app/models/scale.rb:50…54. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location Line 13 - 14 (mass = 40)
Also found in app/models/scale.rb:10…11. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 1 other location Line 103 - 105 (mass = 26)
Also found in app/models/criterion.rb:107…110. Wrap the duplicated code into an instance method
<pre>
def complete_drop_down_label_config(html, label)
html += j.to_s
html += "-" + label if label && label.length>0
html += "</option>"
end
</pre>
* Similar code found in 2 other locations Line 152 - 153 (mass = 22)
Also found in app/models/criterion.rb:115…116, app/models/text_area.rb:12…13. Wrap the duplicated code into an instance method
<pre>
def complete_answer_comment(count, html, answer)
html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
html += answer.comments if !answer.nil?
end
</pre>
* Similar code found in 3 other locations: Line 130 - 134 (mass = 18)
Also found in app/models/criterion.rb:145…149, app/models/scale.rb:45…49, app/models/scale.rb:60…64.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Scale.rb===
* Cyclomatic complexity for complete is too high. Method has too many lines

<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max)
html = self.txt + '<br>'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += 'value="'+answer.answer.to_s+'"' if !answer.nil?
html += '>'
html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'

html += '<table>'
html += '<tr><td width="10%"></td>'
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><label>' +j.to_s+ '</label></td>'
end
html += '<td width="10%"></td></tr><tr>'

html = complete_label(self.min_label, html)
html = complete_questionnaire_min_to_questionnaire_max(self, html, answer, questionnaire_min, questionnaire_max)

html += '<script>jQuery("input[name=Radio_' +self.id.to_s+ ']:radio").change(function() {'
html += 'var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'var checked_value = jQuery("input[name=Radio_' +self.id.to_s+ ']:checked").val();'
html += 'response_score.val(checked_value);});</script>'
html = complete_label(self.max_label, html)

html += '<td width="10%"></td></tr></table>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 17-28
app/models/criterion.rb:20…32, def view_question_text.
The following method is removed from subclass: scale and added to their superclass: scaled_question.

<pre>
#This method returns what to display if an instructor (etc.) is viewing a questionnaire
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 50-54
app/models/criterion.rb:135…139. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question.
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location: line 10-11
app/models/criterion.rb:13…14. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 3 other locations: line 60-64
app/models/criterion.rb:130…134, app/models/criterion.rb:145…149, app/models/scale.rb:45…49.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Checkbox.rb===
* Method has too many lines.
By moving codes to private methods outside this method, this problem can be fixed together with the following one. Here is the new complete method together with two additional private methods: hasAnswer(html, answer) and nextQuestionTail(html, next_question). The source codes are listed as below.
<pre>
def complete(count, answer=nil)
curr_question = Question.find(self.id)
prev_question = Question.where("seq < ?", curr_question.seq).order(:seq).last
next_question = Question.where("seq > ?", curr_question.seq).order(:seq).first
html = ''
if prev_question.type == 'ColumnHeader'
html = '<td style="padding: 15px;">'
end

html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += hasAnswer(html , answer)
html += '>'
html += '<input id="responses_' +count.to_s+ '_checkbox" type="checkbox" onchange="checkbox' +count.to_s+ 'Changed()"'
html += 'checked="checked"' if !answer.nil? and answer.answer == 1
html += '>'
html += '<label for="responses_' +count.to_s+ '">' +self.txt+ '</label>'

html += '<script>function checkbox' +count.to_s+ 'Changed() {'
html += ' var checkbox = jQuery("#responses_' +count.to_s+ '_checkbox");'
html += ' var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'

html = nextQuestionTail(html, next_question)
html.html_safe
end

#YJ private for complete()
def hasAnswer(html, answer)
if !answer.nil? and answer.answer == 1
html += 'value="1"'
else
html += 'value="0"'
end
return html
end

def nextQuestionTail(html, next_q)
if next_question.type == 'ColumnHeader'
html += '</td></tr>'
elsif next_question.type == 'SectionHeader' or next_question.type == 'TableHeader'
html += '</td></tr></table><br/>'
else
html += '<BR/>'
end
return html
end
</pre>
* Cyclomatic complexity for complete is too high.
This problem can be solved by moving branches outside to other private methods. See source code above.
* Similar codes in edit method are found in 2 other locations.
(questionnaire_header.rb and upload_file.rb)
Such code duplication can be eliminated by moving the identical part of the similar edit method to a new function, named edit_prefix(html, count) to their common superclass, which is Question (question.rb).
Here is the source code of the added edit_prefix method in question.rb:
<pre>
def edit_prefix(self, html)
html ='<tr>'
html+='<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' +ob.id.to_s+ '">Remove</a></td>'
html+='<td><input size="6" value="'+ob.seq.to_s+'" name="question['+ob.id.to_s+'][seq]" id="question_'+ob.id.to_s+'_seq" type="text"></td>'
html+='<td><textarea cols="50" rows="1" name="question['+ob.id.to_s+'][txt]" id="question_'+ob.id.to_s+'_txt">'+ob.txt+'</textarea></td>'
html+='<td><input size="10" disabled="disabled" value="'+ob.type+'" name="question['+ob.id.to_s+'][type]" id="question_'+ob.id.to_s+'_type" type="text">''</td>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def edit(count)
html = edit_prefix(self, html)
html+='<td></td>'
html+='</tr>'
html.html_safe
end
</pre>
* Similar codes in view_question_text method are found in 4 other locations.
(dropdown.rb, questionnaire_header.rb, text_response.rb, upload_file.rb)
The solution to this problem is the same as above one, below is the function added in the most common superclass, which is Question, that contains the common parts of the codes found in the view_question_text methods in all five classes.
<pre>
def view_qt_prefix(ob, html)
html = '<TR><TD align="left"> '+ob.txt+ ' </TD>'
html += '<TD align="left">'+ob.type+'</TD>'
html += '<td align="center">'+ob.weight.to_s+'</TD>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def view_question_text
html = view_qt_prefix(ob, html)
html += '<TD align="center">Checked/Unchecked</TD>'
html += '</TR>'
html.html_safe
end
</pre>

===Questionnaire_header.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

===Upload_file.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

<br>

==Unit-tests==
One contribution is to write unite test for four question types. For each of the four required four question types:
*criterion.rb,
*scale.rb,
*checkbox.rb,
*upload_file.rb,
there are four unit tests for the following four functions:
*''edit'',
*''complete'',
*''view_question_text'',
*''view_complete_question_text''.

These four functions are tested since they are these are the only methods that the question types class can perform.

The output of those four functions are HTML format string. We test if the output string is matched with the expected given certain conditions. Here are the spec files git hub links:
*[https://github.com/schen35/expertiza/blob/master/spec/models/criterion_spec.rb criterion_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/scale_spec.rb scale_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/checkbox_spec.rb checkbox_spec.rb]
*[https://github.com/schen35/expertiza/blob/master/spec/models/upload_file_spec.rb upload_file_spec.rb].

User talk:Yjin6

2016-04-01T19:42:38Z

Hguan2: /* Unit-tests */

This wiki page is for the description of changes made under E1624 OSS assignment for Spring 2016, CSC/ECE 517.

== Problem Statement ==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for calibration function.
===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise your tests will not pass on TravisCI.
*Create RSpec file in /spec/features/ folder.
*Use fixtures to create the assignment record and any other records such as participant records in test DB.
*Use Capybara to write functional tests for these three scenarios.
**One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
**One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
**One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
*Create multiple tests to check valid and invalid cases.

User talk:Yjin6

2016-04-01T19:42:22Z

Hguan2: /* What needs to be done */

User talk:Yjin6

2016-04-01T19:40:13Z

Hguan2: /* What needs to be done */

This wiki page is for the description of changes made under E1624 OSS assignment for Spring 2016, CSC/ECE 517.

== Problem Statement ==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for calibration function.
===What needs to be done===
*Understand the flow of the suggested topic function.
*Do not use the development DB, otherwise your tests will not pass on TravisCI.
Create RSpec file in /spec/features/ folder.
Use fixtures to create the assignment record and any other records such as participant records in test DB.
Use Capybara to write functional tests for these three scenarios.
One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
Create multiple tests to check valid and invalid cases.

==Unit-tests==

User talk:Yjin6

2016-04-01T19:38:52Z

Hguan2: /* Problem Statement */

This wiki page is for the description of changes made under E1624 OSS assignment for Spring 2016, CSC/ECE 517.

== Problem Statement ==

===What it does===
Suggested topic functionality is designed for students to suggest topics they interested in. An assignment can be set up to allow students to suggest topics at the discretion of the instructor. Then, students can suggest topics, and add related descriptions. The proposer can state that (s)he wants to work on the suggested topic. When the instructor approves a suggested topic, if the proposer wanted to work on it, it is assigned to the proposer. Otherwise, it is placed on the signup sheet for anyone to reserve. The purpose of suggested topic is to make the writing assignment more personalized.
===What’s wrong with it===
Currently, there is no functional test for calibration function.
===What needs to be done===
Understand the flow of the suggested topic function.
Do not use the development DB, otherwise your tests will not pass on TravisCI.
Create RSpec file in /spec/features/ folder.
Use fixtures to create the assignment record and any other records such as participant records in test DB.
Use Capybara to write functional tests for these three scenarios.
One team is on the waitlist. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved, they should leave the waitlist and hold their suggested topic;
One team is holding a topic. They sent a suggestion for new topic and they want to choose their suggested topic. After their suggested topic is approved and they choose to switch to suggested topic, they will hold suggested topic and their old topic will be released. And if another team is in waitlist of that old topic, that team should hold the old topic now;
One team is holding a topic. They sent a suggestion for new topic and they do not want to work on their suggested topic. After their suggested topic is approved and they choose to public suggested topic, they will still hold their old topic. Their suggested topic will be added in sign-up sheet.
Create multiple tests to check valid and invalid cases.

==Unit-tests==

CSC/ECE 517 Spring 2016

2016-03-29T02:09:59Z

Hguan2: /* Writing Assignment 2 */

==Calibration Assignment Submissions==
*[[Calibration Assignment Submission (OmniAuth)]]
*[[Calibration Assignment Submission (Patch_verb)]]

==Writing Assignment 2==
[[CSC/ECE 517 Spring 2016/Mozilla Implement HTML5 form validation]]

[[CSC/ECE 517 Spring 2016/Functional Tests for Questionnaire Controller]]

[[CSC/ECE 517 Spring 2016 / Expertiza Self-Review Feature]]

[[CSC/ECE 517 Spring 2016/Refactor different question types from quiz feature]]

[[CSC/ECE 517 Spring 2016/Implement private browsing]]

[[CSC/ECE 517 Spring 2016/Write automated tests for WebDriver]]

[[CSC/ECE 517 Spring 2016/Refactor sign_up_sheet_controller.rb and sign_up_topic.rb]]

[[CSC/ECE 517 Spring 2016/Implement Common Parts of the CSSOM API]]

[[CSC/ECE 517 Spring 2016/Functional tests for assignment creation function]]

[[CSC/ECE 517 Spring 2016/E1604. Functional tests for Calibration function]]

[[CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb]]

E1608: Refactor and write unit tests for question type.rb

2016-03-29T02:09:01Z

Hguan2: moved E1608: Refactor and write unit tests for question type.rb to CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

#REDIRECT [[CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb]]

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-29T02:09:01Z

Hguan2: moved E1608: Refactor and write unit tests for question type.rb to CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

This wiki page is for the description of changes made under E1608 OSS assignment for Spring 2016, CSC/ECE 517. The assignment task is to refactor & write unit tests for [question_type].rb (eg. criterion.rb).

== Problem Statement ==
===Files related===
Four models is related: criterion.rb, scale.rb, checkbox.rb, questionnaire_header.rb, upload_file.rb. There are 4 methods “edit”, “view_question_text”, “complete” and “view_completed_question” correspond to different views.

*edit ~> when instructor add/edit new questions
*view ~> when instructor view existed questions
*complete ~> when students do peer reviews
*view_completed_question ~> when student view existed peer reviews

===Expertiza question types inheritance hierarchy===

*Choice question
**Scored question
***Scale
***Criterion
**Unscored question
***Dropdown
***CheckBox
*TextResponse
**TextArea
**TextField
*UploadFile

===Files problem===

There are some issues in each file, such as security, complexity, duplication, etc. And currently there is no unit tests for [question_type].rb.

===Our contribution===
*Refactor these [question_type].rb files and fix issues.
*Keep the inputs and outputs of these methods (edit, view, complete, view_completed_question) the same as before.
*Write unit tests for [question_type].rb listed above.
*Create RSpec files for each question type in /spec/models/ folder
*Create multiple tests to check valid and invalid cases, such as input including special character double quote (“”).

<br>
==Refactor==
===Criterion.rb===
* Method has too many lines: Line 35 - 158 [106/30]
Wrap the specific code into different instance methods.
* Cyclomatic complexity for complete is too high: Line 35 - 158 [28/6]
Wrap the code into different instance methods to reduce cyclomatic complexity
<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
if self.size.nil?
cols = '70'
rows = '1'
else
cols = self.size.split(',')[0]
rows = self.size.split(',')[1]
end
html = '<li><div><label for="responses_' +count.to_s+ '">' +self.txt+ "</label></div>"
#show advice for each criterion question
question_advices = QuestionAdvice.where(question_id: self.id).sort_by { |advice| advice.id }
advice_total_length = 0
question_advices.each do |question_advice|
if question_advice.advice && !question_advice.advice == ""
advice_total_length += question_advice.advice.length
end
end
if question_advices.length > 0 and advice_total_length > 0
html = complete_show_advice(self, html)
question_advices.reverse.each_with_index do |question_advice, index|
html += '<a id="changeScore_>' + self.id.to_s + '" onclick="changeScore(' + count.to_s + ',' + index.to_s + ')">'
html += (question_advices.length - index).to_s + ' - ' + question_advice.advice + '</a><br/>'
html += '<script>'
html += 'function changeScore(i, j) {'
html += 'var elem = jQuery("#responses_" + i.toString() + "_score");'
html += 'var opts = elem.children("option").length;'
html += 'elem.val((opts - j - 1).toString());}'
html += '</script>'
end
html += '</div>'
end
if dropdown_or_scale == 'dropdown'
## code added to reduce Cyclomatic Complexity
html = complete_drop_down(self, html, count, answer, questionnaire_min, questionnaire_max)
elsif dropdown_or_scale == 'scale'
html = complete_scale(self, html, count, answer, questionnaire_min, questionnaire_max)
end
html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 20 - 32 (mass = 89)
Also found in app/models/scale.rb:17…28. The following method is removed from subclass: criterion and added to their superclass: scaled_question
<pre>
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
Html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 135 - 139 (mass = 50)
Also found in app/models/scale.rb:50…54. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location Line 13 - 14 (mass = 40)
Also found in app/models/scale.rb:10…11. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 1 other location Line 103 - 105 (mass = 26)
Also found in app/models/criterion.rb:107…110. Wrap the duplicated code into an instance method
<pre>
def complete_drop_down_label_config(html, label)
html += j.to_s
html += "-" + label if label && label.length>0
html += "</option>"
end
</pre>
* Similar code found in 2 other locations Line 152 - 153 (mass = 22)
Also found in app/models/criterion.rb:115…116, app/models/text_area.rb:12…13. Wrap the duplicated code into an instance method
<pre>
def complete_answer_comment(count, html, answer)
html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
html += answer.comments if !answer.nil?
end
</pre>
* Similar code found in 3 other locations: Line 130 - 134 (mass = 18)
Also found in app/models/criterion.rb:145…149, app/models/scale.rb:45…49, app/models/scale.rb:60…64.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Scale.rb===
* Cyclomatic complexity for complete is too high. Method has too many lines

<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max)
html = self.txt + '<br>'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += 'value="'+answer.answer.to_s+'"' if !answer.nil?
html += '>'
html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'

html += '<table>'
html += '<tr><td width="10%"></td>'
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><label>' +j.to_s+ '</label></td>'
end
html += '<td width="10%"></td></tr><tr>'

html = complete_label(self.min_label, html)
html = complete_questionnaire_min_to_questionnaire_max(self, html, answer, questionnaire_min, questionnaire_max)

html += '<script>jQuery("input[name=Radio_' +self.id.to_s+ ']:radio").change(function() {'
html += 'var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'var checked_value = jQuery("input[name=Radio_' +self.id.to_s+ ']:checked").val();'
html += 'response_score.val(checked_value);});</script>'
html = complete_label(self.max_label, html)

html += '<td width="10%"></td></tr></table>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 17-28
app/models/criterion.rb:20…32, def view_question_text.
The following method is removed from subclass: scale and added to their superclass: scaled_question.

<pre>
#This method returns what to display if an instructor (etc.) is viewing a questionnaire
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 50-54
app/models/criterion.rb:135…139. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question.
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location: line 10-11
app/models/criterion.rb:13…14. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 3 other locations: line 60-64
app/models/criterion.rb:130…134, app/models/criterion.rb:145…149, app/models/scale.rb:45…49.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Checkbox.rb===
* Method has too many lines.
By moving codes to private methods outside this method, this problem can be fixed together with the following one. Here is the new complete method together with two additional private methods: hasAnswer(html, answer) and nextQuestionTail(html, next_question). The source codes are listed as below.
<pre>
def complete(count, answer=nil)
curr_question = Question.find(self.id)
prev_question = Question.where("seq < ?", curr_question.seq).order(:seq).last
next_question = Question.where("seq > ?", curr_question.seq).order(:seq).first
html = ''
if prev_question.type == 'ColumnHeader'
html = '<td style="padding: 15px;">'
end

html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += hasAnswer(html , answer)
html += '>'
html += '<input id="responses_' +count.to_s+ '_checkbox" type="checkbox" onchange="checkbox' +count.to_s+ 'Changed()"'
html += 'checked="checked"' if !answer.nil? and answer.answer == 1
html += '>'
html += '<label for="responses_' +count.to_s+ '">' +self.txt+ '</label>'

html += '<script>function checkbox' +count.to_s+ 'Changed() {'
html += ' var checkbox = jQuery("#responses_' +count.to_s+ '_checkbox");'
html += ' var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'

html = nextQuestionTail(html, next_question)
html.html_safe
end

#YJ private for complete()
def hasAnswer(html, answer)
if !answer.nil? and answer.answer == 1
html += 'value="1"'
else
html += 'value="0"'
end
return html
end

def nextQuestionTail(html, next_q)
if next_question.type == 'ColumnHeader'
html += '</td></tr>'
elsif next_question.type == 'SectionHeader' or next_question.type == 'TableHeader'
html += '</td></tr></table><br/>'
else
html += '<BR/>'
end
return html
end
</pre>
* Cyclomatic complexity for complete is too high.
This problem can be solved by moving branches outside to other private methods. See source code above.
* Similar codes in edit method are found in 2 other locations.
(questionnaire_header.rb and upload_file.rb)
Such code duplication can be eliminated by moving the identical part of the similar edit method to a new function, named edit_prefix(html, count) to their common superclass, which is Question (question.rb).
Here is the source code of the added edit_prefix method in question.rb:
<pre>
def edit_prefix(self, html)
html ='<tr>'
html+='<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' +ob.id.to_s+ '">Remove</a></td>'
html+='<td><input size="6" value="'+ob.seq.to_s+'" name="question['+ob.id.to_s+'][seq]" id="question_'+ob.id.to_s+'_seq" type="text"></td>'
html+='<td><textarea cols="50" rows="1" name="question['+ob.id.to_s+'][txt]" id="question_'+ob.id.to_s+'_txt">'+ob.txt+'</textarea></td>'
html+='<td><input size="10" disabled="disabled" value="'+ob.type+'" name="question['+ob.id.to_s+'][type]" id="question_'+ob.id.to_s+'_type" type="text">''</td>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def edit(count)
html = edit_prefix(self, html)
html+='<td></td>'
html+='</tr>'
html.html_safe
end
</pre>
* Similar codes in view_question_text method are found in 4 other locations.
(dropdown.rb, questionnaire_header.rb, text_response.rb, upload_file.rb)
The solution to this problem is the same as above one, below is the function added in the most common superclass, which is Question, that contains the common parts of the codes found in the view_question_text methods in all five classes.
<pre>
def view_qt_prefix(ob, html)
html = '<TR><TD align="left"> '+ob.txt+ ' </TD>'
html += '<TD align="left">'+ob.type+'</TD>'
html += '<td align="center">'+ob.weight.to_s+'</TD>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def view_question_text
html = view_qt_prefix(ob, html)
html += '<TD align="center">Checked/Unchecked</TD>'
html += '</TR>'
html.html_safe
end
</pre>

===Questionnaire_header.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

===Upload_file.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

<br>

==Unit-tests==
For each of the four required four question types (criterion.rb, scale.rb, checkbox.rb, upload_file.rb), there are four unit tests for the following four functions: ''edit'', ''complete'', ''view_question_text'', and ''view_complete_question_text''. Here are the spec files git hub links:
[https://github.com/schen35/expertiza/blob/master/spec/models/criterion_spec.rb criterion_spec.rb] [https://github.com/schen35/expertiza/blob/master/spec/models/scale_spec.rb scale_spec.rb]
[https://github.com/schen35/expertiza/blob/master/spec/models/checkbox_spec.rb checkbox_spec.rb]
[https://github.com/schen35/expertiza/blob/master/spec/models/upload_file_spec.rb upload_file_spec.rb].

User:Hguan2

2016-03-29T02:05:47Z

Hguan2: moved User:Hguan2 to E1608: Refactor and write unit tests for question type.rb: change the title to the writing assignment title

#REDIRECT [[E1608: Refactor and write unit tests for question type.rb]]

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-29T02:05:47Z

Hguan2: moved User:Hguan2 to E1608: Refactor and write unit tests for question type.rb: change the title to the writing assignment title

This wiki page is for the description of changes made under E1608 OSS assignment for Spring 2016, CSC/ECE 517. The assignment task is to refactor & write unit tests for [question_type].rb (eg. criterion.rb).

== Problem Statement ==
===Files related===
Four models is related: criterion.rb, scale.rb, checkbox.rb, questionnaire_header.rb, upload_file.rb. There are 4 methods “edit”, “view_question_text”, “complete” and “view_completed_question” correspond to different views.

*edit ~> when instructor add/edit new questions
*view ~> when instructor view existed questions
*complete ~> when students do peer reviews
*view_completed_question ~> when student view existed peer reviews

===Expertiza question types inheritance hierarchy===

*Choice question
**Scored question
***Scale
***Criterion
**Unscored question
***Dropdown
***CheckBox
*TextResponse
**TextArea
**TextField
*UploadFile

===Files problem===

There are some issues in each file, such as security, complexity, duplication, etc. And currently there is no unit tests for [question_type].rb.

===Our contribution===
*Refactor these [question_type].rb files and fix issues.
*Keep the inputs and outputs of these methods (edit, view, complete, view_completed_question) the same as before.
*Write unit tests for [question_type].rb listed above.
*Create RSpec files for each question type in /spec/models/ folder
*Create multiple tests to check valid and invalid cases, such as input including special character double quote (“”).

<br>
==Refactor==
===Criterion.rb===
* Method has too many lines: Line 35 - 158 [106/30]
Wrap the specific code into different instance methods.
* Cyclomatic complexity for complete is too high: Line 35 - 158 [28/6]
Wrap the code into different instance methods to reduce cyclomatic complexity
<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
if self.size.nil?
cols = '70'
rows = '1'
else
cols = self.size.split(',')[0]
rows = self.size.split(',')[1]
end
html = '<li><div><label for="responses_' +count.to_s+ '">' +self.txt+ "</label></div>"
#show advice for each criterion question
question_advices = QuestionAdvice.where(question_id: self.id).sort_by { |advice| advice.id }
advice_total_length = 0
question_advices.each do |question_advice|
if question_advice.advice && !question_advice.advice == ""
advice_total_length += question_advice.advice.length
end
end
if question_advices.length > 0 and advice_total_length > 0
html = complete_show_advice(self, html)
question_advices.reverse.each_with_index do |question_advice, index|
html += '<a id="changeScore_>' + self.id.to_s + '" onclick="changeScore(' + count.to_s + ',' + index.to_s + ')">'
html += (question_advices.length - index).to_s + ' - ' + question_advice.advice + '</a><br/>'
html += '<script>'
html += 'function changeScore(i, j) {'
html += 'var elem = jQuery("#responses_" + i.toString() + "_score");'
html += 'var opts = elem.children("option").length;'
html += 'elem.val((opts - j - 1).toString());}'
html += '</script>'
end
html += '</div>'
end
if dropdown_or_scale == 'dropdown'
## code added to reduce Cyclomatic Complexity
html = complete_drop_down(self, html, count, answer, questionnaire_min, questionnaire_max)
elsif dropdown_or_scale == 'scale'
html = complete_scale(self, html, count, answer, questionnaire_min, questionnaire_max)
end
html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 20 - 32 (mass = 89)
Also found in app/models/scale.rb:17…28. The following method is removed from subclass: criterion and added to their superclass: scaled_question
<pre>
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
Html.html_safe
end
</pre>
* Identical code found in 1 other location: Line 135 - 139 (mass = 50)
Also found in app/models/scale.rb:50…54. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location Line 13 - 14 (mass = 40)
Also found in app/models/scale.rb:10…11. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 1 other location Line 103 - 105 (mass = 26)
Also found in app/models/criterion.rb:107…110. Wrap the duplicated code into an instance method
<pre>
def complete_drop_down_label_config(html, label)
html += j.to_s
html += "-" + label if label && label.length>0
html += "</option>"
end
</pre>
* Similar code found in 2 other locations Line 152 - 153 (mass = 22)
Also found in app/models/criterion.rb:115…116, app/models/text_area.rb:12…13. Wrap the duplicated code into an instance method
<pre>
def complete_answer_comment(count, html, answer)
html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
html += answer.comments if !answer.nil?
end
</pre>
* Similar code found in 3 other locations: Line 130 - 134 (mass = 18)
Also found in app/models/criterion.rb:145…149, app/models/scale.rb:45…49, app/models/scale.rb:60…64.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Scale.rb===
* Cyclomatic complexity for complete is too high. Method has too many lines

<pre>
def complete(count, answer=nil, questionnaire_min, questionnaire_max)
html = self.txt + '<br>'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += 'value="'+answer.answer.to_s+'"' if !answer.nil?
html += '>'
html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'

html += '<table>'
html += '<tr><td width="10%"></td>'
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><label>' +j.to_s+ '</label></td>'
end
html += '<td width="10%"></td></tr><tr>'

html = complete_label(self.min_label, html)
html = complete_questionnaire_min_to_questionnaire_max(self, html, answer, questionnaire_min, questionnaire_max)

html += '<script>jQuery("input[name=Radio_' +self.id.to_s+ ']:radio").change(function() {'
html += 'var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'var checked_value = jQuery("input[name=Radio_' +self.id.to_s+ ']:checked").val();'
html += 'response_score.val(checked_value);});</script>'
html = complete_label(self.max_label, html)

html += '<td width="10%"></td></tr></table>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 17-28
app/models/criterion.rb:20…32, def view_question_text.
The following method is removed from subclass: scale and added to their superclass: scaled_question.

<pre>
#This method returns what to display if an instructor (etc.) is viewing a questionnaire
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
html.html_safe
end
</pre>
* Identical code found in 1 other location: line 50-54
app/models/criterion.rb:135…139. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question.
<pre>
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end
</pre>
* Identical code found in 1 other location: line 10-11
app/models/criterion.rb:13…14. Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end
</pre>
* Similar code found in 3 other locations: line 60-64
app/models/criterion.rb:130…134, app/models/criterion.rb:145…149, app/models/scale.rb:45…49.
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
<pre>
# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end
</pre>

===Checkbox.rb===
* Method has too many lines.
By moving codes to private methods outside this method, this problem can be fixed together with the following one. Here is the new complete method together with two additional private methods: hasAnswer(html, answer) and nextQuestionTail(html, next_question). The source codes are listed as below.
<pre>
def complete(count, answer=nil)
curr_question = Question.find(self.id)
prev_question = Question.where("seq < ?", curr_question.seq).order(:seq).last
next_question = Question.where("seq > ?", curr_question.seq).order(:seq).first
html = ''
if prev_question.type == 'ColumnHeader'
html = '<td style="padding: 15px;">'
end

html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += hasAnswer(html , answer)
html += '>'
html += '<input id="responses_' +count.to_s+ '_checkbox" type="checkbox" onchange="checkbox' +count.to_s+ 'Changed()"'
html += 'checked="checked"' if !answer.nil? and answer.answer == 1
html += '>'
html += '<label for="responses_' +count.to_s+ '">' +self.txt+ '</label>'

html += '<script>function checkbox' +count.to_s+ 'Changed() {'
html += ' var checkbox = jQuery("#responses_' +count.to_s+ '_checkbox");'
html += ' var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'

html = nextQuestionTail(html, next_question)
html.html_safe
end

#YJ private for complete()
def hasAnswer(html, answer)
if !answer.nil? and answer.answer == 1
html += 'value="1"'
else
html += 'value="0"'
end
return html
end

def nextQuestionTail(html, next_q)
if next_question.type == 'ColumnHeader'
html += '</td></tr>'
elsif next_question.type == 'SectionHeader' or next_question.type == 'TableHeader'
html += '</td></tr></table><br/>'
else
html += '<BR/>'
end
return html
end
</pre>
* Cyclomatic complexity for complete is too high.
This problem can be solved by moving branches outside to other private methods. See source code above.
* Similar codes in edit method are found in 2 other locations.
(questionnaire_header.rb and upload_file.rb)
Such code duplication can be eliminated by moving the identical part of the similar edit method to a new function, named edit_prefix(html, count) to their common superclass, which is Question (question.rb).
Here is the source code of the added edit_prefix method in question.rb:
<pre>
def edit_prefix(self, html)
html ='<tr>'
html+='<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' +ob.id.to_s+ '">Remove</a></td>'
html+='<td><input size="6" value="'+ob.seq.to_s+'" name="question['+ob.id.to_s+'][seq]" id="question_'+ob.id.to_s+'_seq" type="text"></td>'
html+='<td><textarea cols="50" rows="1" name="question['+ob.id.to_s+'][txt]" id="question_'+ob.id.to_s+'_txt">'+ob.txt+'</textarea></td>'
html+='<td><input size="10" disabled="disabled" value="'+ob.type+'" name="question['+ob.id.to_s+'][type]" id="question_'+ob.id.to_s+'_type" type="text">''</td>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def edit(count)
html = edit_prefix(self, html)
html+='<td></td>'
html+='</tr>'
html.html_safe
end
</pre>
* Similar codes in view_question_text method are found in 4 other locations.
(dropdown.rb, questionnaire_header.rb, text_response.rb, upload_file.rb)
The solution to this problem is the same as above one, below is the function added in the most common superclass, which is Question, that contains the common parts of the codes found in the view_question_text methods in all five classes.
<pre>
def view_qt_prefix(ob, html)
html = '<TR><TD align="left"> '+ob.txt+ ' </TD>'
html += '<TD align="left">'+ob.type+'</TD>'
html += '<td align="center">'+ob.weight.to_s+'</TD>'
end
</pre>
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:
<pre>
def view_question_text
html = view_qt_prefix(ob, html)
html += '<TD align="center">Checked/Unchecked</TD>'
html += '</TR>'
html.html_safe
end
</pre>

===Questionnaire_header.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

===Upload_file.rb===
All problems in this file are solved after solving the problems found in checkbox.rb.

<br>

==Unit-tests==
For each of the four required four question types (criterion.rb, scale.rb, checkbox.rb, upload_file.rb), there are four unit tests for the following four functions: ''edit'', ''complete'', ''view_question_text'', and ''view_complete_question_text''. Here are the spec files git hub links:
[https://github.com/schen35/expertiza/blob/master/spec/models/criterion_spec.rb criterion_spec.rb] [https://github.com/schen35/expertiza/blob/master/spec/models/scale_spec.rb scale_spec.rb]
[https://github.com/schen35/expertiza/blob/master/spec/models/checkbox_spec.rb checkbox_spec.rb]
[https://github.com/schen35/expertiza/blob/master/spec/models/upload_file_spec.rb upload_file_spec.rb].

MainPage

2016-03-24T02:57:06Z

Hguan2: Undo revision 101259 by Xpan (talk)

==Course-Specific Topics==

* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Fall 2015]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC/ECE 517 Spring 2015]]
* [[CSC/ECE 517 Spring 2016]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]

==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]

MainPage

2016-03-24T02:56:57Z

Hguan2: Undo revision 101260 by Xpan (talk)

==Functional tests for assignment creation function Topics==

* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Fall 2015]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC/ECE 517 Spring 2015]]
* [[CSC/ECE 517 Spring 2016]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]

==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]

MainPage

2016-03-24T02:56:46Z

Hguan2: Undo revision 101261 by Xpan (talk)

==Functional tests for assignment creation function==

"General" tab function,
"Topics" tab function, you need to ensure topic creation functionality works.
"Rubrics" tab function, you need to test each questionnaire dropdowns, scored-question display style dropdowns, weight text fields and notification limit text fields and make sure they can be saved successfully.
"Due dates" tab function, you need to test “Date & time” date selectors and other action-allowed dropdowns and make sure they can be saved successfully.
==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]

MainPage

2016-03-24T02:56:34Z

Hguan2: Undo revision 101262 by Xpan (talk)

==Functional tests for assignment creation function==

"General" tab function,
"Topics" tab function, you need to ensure topic creation functionality works.
"Rubrics" tab function, you need to test each questionnaire dropdowns, scored-question display style dropdowns, weight text fields and notification limit text fields and make sure they can be saved successfully.
"Due dates" tab function, you need to test “Date & time” date selectors and other action-allowed dropdowns and make sure they can be saved successfully.
==Application Behavior==
* [[Grading]]

=="General" tab function==
you need to test assignment name, course, submission directory, description URL, ‘Has team?’, ‘Has quiz?’ and ‘Calibrated peer-review for training’ and make sure either text fields or checkboxes can be saved successfully.

=="Topics" tab function==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]

=="Rubrics" tab function==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

=="Due dates" tab function==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]

MainPage

2016-03-24T02:56:26Z

Hguan2: Undo revision 101271 by Xpan (talk)

MainPage

2016-03-24T02:56:18Z

Hguan2: Undo revision 101272 by Xpan (talk)

==Functional tests for assignment creation function==

"General" tab function,
"Topics" tab function
"Rubrics" tab function
"Due dates" tab function

=="General" tab function==
you need to test assignment name, course, submission directory, description URL, ‘Has team?’, ‘Has quiz?’ and ‘Calibrated peer-review for training’ and make sure either text fields or checkboxes can be saved successfully.

=="Topics" tab function==

=="Rubrics" tab function==

=="Due dates" tab function==

MainPage

2016-03-24T02:56:04Z

Hguan2: Undo revision 101274 by Xpan (talk)

MainPage

2016-03-24T02:55:55Z

Hguan2: Undo revision 101285 by Xpan (talk)

MainPage

2016-03-24T02:55:46Z

Hguan2: Undo revision 101287 by Xpan (talk)

MainPage

2016-03-24T02:55:33Z

Hguan2: Undo revision 101294 by Xpan (talk)

MainPage

2016-03-24T02:55:11Z

Hguan2: Undo revision 101297 by Xpan (talk)

==Functional tests for assignment creation function==

*"General" tab function,
*"Topics" tab function,
*"Rubrics" tab function,
*"Due dates" tab function,

=="General" tab function==
In this section, the functional test includes assignment name, course, submission directory, description URL, "Has team?", "Has quiz?" and "Calibrated peer-review for training".
*assignment name
<pre>
it "can set assginment name" do
login_as("instructor6")
visit '/assignments/new?private=0'
expect(page).to have_content "Assignment name"
fill_in "Assignment name:", with: 'assignment for test'
click_button "Create"
expect(Assignment.where(name: "assignment for test")).to exist
end
</pre>
*course
<pre>
it "can select course" do
login_as("instructor6")
visit '/assignments/new?private=0'
select('5', :from => 'assignment_form_assignment_course_id')
click_button "Create"
end
</pre>
*submission directory
<pre>
it "can set assginment Submission directory" do
login_as("instructor6")
visit '/assignments/new?private=0'
fill_in "Assignment name:", with: 'assignment for test 2'
expect(page).to have_content "Submission directory"
fill_in "Submission directory:", with: 'Submission directory for test'
click_button "Create"
expect(Assignment.find(2).directory_path).to eq 'Submission directory for test'
end
</pre>
*description URL
<pre>
it "can set assginment Description URL" do
login_as("instructor6")
visit '/assignments/new?private=0'
fill_in "Assignment name:", with: 'assignment for test 3'
expect(page).to have_content "Description URL"
fill_in "Description URL:", with: 'Description URL for test'
click_button "Create"
expect(Assignment.find(2).spec_location).to eq 'Description URL for test'
end
</pre>
*"Has team?"
<pre>
it "can Has teams and set team number" do
login_as("instructor6")
visit '/assignments/new?private=0'
fill_in "Assignment name:", with: 'assignment for test 5'
find('#team_assignment').set(true)
expect(page).to have_content "Maximum number of members per team"
expect(page).to have_content "Show teammate reviews"
fill_in 'assignment_form_assignment_max_team_size', with: 4
find('#assignment_form_assignment_show_teammate_reviews').set(true)
click_button "Create"
expect(Assignment.find(2).show_teammate_reviews).to eq true
end
</pre>
*"Has quiz?"
<pre>
it "can save the number of quiz questions" do
login_as("instructor6")
visit '/assignments/new?private=0'
fill_in "Assignment name:", with: '11'
select('5', :from => 'assignment_form_assignment_course_id')
find('#assignment_form_assignment_require_quiz').set(true)
click_button "Create"
visit '/assignments/2/edit'
expect(page).to have_content "Number of Quiz questions"
end
</pre>
*"Calibrated peer-review for training"
<pre>
it "can set Calibrated peer-view for training" do
login_as("instructor6")
visit '/assignments/new?private=0'
fill_in "Assignment name:", with: 'assignment for test 4'
find('#assignment_form_assignment_is_calibrated').set(true)
click_button "Create"
expect(Assignment.find(2).is_calibrated).to eq true
end
</pre>
=="Topics" tab function==

=="Rubrics" tab function==

=="Due dates" tab function==

MainPage

2016-03-24T02:51:27Z

Hguan2: Undo revision 101298 by Xpan (talk)

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T21:11:00Z

Hguan2: /* Our contribution */

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T21:10:06Z

Hguan2: /* Problem Statement */

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T21:09:15Z

Hguan2: /* Problem Statement */

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T21:05:26Z

Hguan2: /* Problem Statement */

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T21:04:46Z

Hguan2: /* Problem Statement */

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T21:03:02Z

Hguan2: problem statement

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T20:59:11Z

Hguan2: test

This wiki page is for the description of changes made under E1608OSS assignment for Spring 2016, CSC/ECE 517.

CSC/ECE 517 Spring 2016/Refactor and write unit tests for question type.rb

2016-03-21T20:13:51Z

Hguan2: initialize

E1608. Refactor & write unit tests for [question_type].rb (eg. criterion.rb)
Contact: Zhewei Hu (zhu6@ncsu.edu)
What it does: In last summer we refactored different class of questions to make them follow the same design (you can take a look on Criterion.rb): there are 4 methods “edit”, “view_question_text”, “complete” and “view_completed_question” correspond to different views.
Files involved: criterion.rb, scale.rb, checkbox.rb, questionnaire_header.rb, upload_file.rb
edit ~> when instructor add/edit new questions
view ~> when instructor view existed questions
complete ~> when students do peer reviews
view_completed_question ~> when student view existed peer reviews
Expertiza question types inheritance hierarchy
Choice question
Scored question
Scale
Criterion
Unscored question
Dropdown
CheckBox
TextResponse
TextArea
TextField
UploadFile
What’s wrong with it: You can click these [question_type].rb files listed above. These links will redirect to Code Climate. You need to fix these issues in each file, such as security, complexity, duplication, etc. And currently there is no unit tests for [question_type].rb.
What needs to be done:
Refactor these [question_type].rb files and fix issues.
Keep the inputs and outputs of these methods (edit, view, complete, view_completed_question) the same as before.
Write unit tests for [question_type].rb listed above.
Create RSpec files for each question type in /spec/models/ folder
Create multiple tests to check valid and invalid cases, such as input including special character double quote (“”).

�

What needs to be done:
Refactor
Criterion.rb
1. Method has too many lines: Line 35 - 158 [106/30]
2. Cyclomatic complexity for complete is too high: Line 35 - 158 [28/6]
3. Identical code found in 1 other location: Line 20 - 32 (mass = 89)
4. Identical code found in 1 other location: Line 135 - 139 (mass = 50)
5. Identical code found in 1 other location Line 13 - 14 (mass = 40)
6. Similar code found in 1 other location Line 103 - 105 (mass = 26)
7. Similar code found in 2 other locations Line 152 - 153 (mass = 22)
8. Similar code found in 3 other locations: Line 130 - 134 (mass = 18)
Scale.rb
Cyclomatic complexity for complete is too high. Method has too many lines
Identical code found in 1 other location: line 17-28
Identical code found in 1 other location: line 50-54
Identical code found in 1 other location: line 10-11
Similar code found in 3 other locations: line 60-64
Checkbox.rb
Method has too many lines.
Cyclomatic complexity for complete is too high.
Similar codes in edit method are found in 2 other locations.
Similar codes in view_question_text method are found in 4 other locations.
Questionnaire_header.rb
Upload_file.rb
Unit-test
Criterion.rb
Scale.rb
Checkbox.rb
Questionnaire_header.rb
Upload_file.rb

Refactor
Criterion.rb

1. Method has too many lines: Line 35 - 158 [106/30]
def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
Wrap the specific code into different instance methods
2. Cyclomatic complexity for complete is too high: Line 35 - 158 [28/6]
def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
Wrap the code into different instance methods to reduce cyclomatic complexity

def complete(count, answer=nil, questionnaire_min, questionnaire_max, dropdown_or_scale)
if self.size.nil?
cols = '70'
rows = '1'
else
cols = self.size.split(',')[0]
rows = self.size.split(',')[1]
end

html = '<li><div><label for="responses_' +count.to_s+ '">' +self.txt+ '</label></div>'
#show advice for each criterion question
question_advices = QuestionAdvice.where(question_id: self.id).sort_by { |advice| advice.id }
advice_total_length = 0

question_advices.each do |question_advice|
if question_advice.advice && !question_advice.advice == ""
advice_total_length += question_advice.advice.length
end
end

if question_advices.length > 0 and advice_total_length > 0
# html += '<a id="showAdivce_' + self.id.to_s + '" onclick="showAdvice(' + self.id.to_s + ')">Show advice</a>'
# html += '<script>'
# html += 'function showAdvice(i){'
# html += 'var element = document.getElementById("showAdivce_" + i.toString());'
# html += 'var show = element.innerHTML == "Hide advice";'
# html += 'if (show){'
# html += 'element.innerHTML="Show advice";'
# html += '}else{'
# html += 'element.innerHTML="Hide advice";}'
# html += 'toggleAdvice(i);}'
#
# html += 'function toggleAdvice(i) {'
# html += 'var elem = document.getElementById(i.toString() + "_myDiv");'
# html += 'if (elem.style.display == "none") {'
# html += 'elem.style.display = "";'
# html += '} else {'
# html += 'elem.style.display = "none";}}'
# html += '</script>'
#
# html += '<div id="' + self.id.to_s + '_myDiv" style="display: none;">'

# code added to reduce complexity
html = complete_show_advice(self, html)

#[2015-10-26] Zhewei:
#best to order advices high to low, e.g., 5 to 1
#each level used to be a link;
#clicking on the link caused the dropbox to be filled in with the corresponding number
question_advices.reverse.each_with_index do |question_advice, index|
html += '<a id="changeScore_>' + self.id.to_s + '" onclick="changeScore(' + count.to_s + ',' + index.to_s + ')">'
html += (question_advices.length - index).to_s + ' - ' + question_advice.advice + '</a><br/>'
html += '<script>'
html += 'function changeScore(i, j) {'
html += 'var elem = jQuery("#responses_" + i.toString() + "_score");'
html += 'var opts = elem.children("option").length;'
html += 'elem.val((opts - j - 1).toString());}'
html += '</script>'
end
html += '</div>'
end

if dropdown_or_scale == 'dropdown'
# html += '<div><select id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]">'
# html += '<option value=''>--</option>'
# for j in questionnaire_min..questionnaire_max
# if !answer.nil? and j == answer.answer
# html += '<option value=' + j.to_s + ' selected="selected">'
# else
# html += '<option value=' + j.to_s + '>'
# end
# if j == questionnaire_min
# html += j.to_s
# html += "-" + self.min_label if self.min_label && self.min_label.length>0
# html += "</option>"
# elsif j == questionnaire_max
# html += j.to_s
# html += "-" + self.max_label if self.max_label && self.max_label.length>0
# html += "</option>"
# else
# html += j.to_s + "</option>"
# end
# end
# html += "</select></div>"
# html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
# html += answer.comments if !answer.nil?
# html += '</textarea></td></br><br/>'

## code added to reduce Cyclomatic Complexity
html = complete_drop_down(self, html, count, answer, questionnaire_min, questionnaire_max)

elsif dropdown_or_scale == 'scale'
# html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
# html += 'value="'+answer.answer.to_s+'"' if !answer.nil?
# html += '>'
#
# html += '<table>'
# html += '<tr><td width="10%"></td>'
# for j in questionnaire_min..questionnaire_max
# html += '<td width="10%"><label>' +j.to_s+ '</label></td>'
# end
# html += '<td width="10%"></td></tr><tr>'
#
# # if !self.min_label.nil?
# # html += '<td width="10%">' +self.min_label+ '</td>'
# # else
# # html += '<td width="10%"></td>'
# # end
# ## code added to remove duplicated code
# html = complete_min_label_condition(self, html)
#
#
# ##
# # for j in questionnaire_min..questionnaire_max
# # html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +self.id.to_s+ '"'
# # html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
# # html += '></td>'
# # end
# ## code added to remove duplicated code
# html = complete_questionnaire_min_to_questionnaire_max(self, html, answer, questionnaire_min, questionnaire_max)
#
# html += '<script>jQuery("input[name=Radio_' +self.id.to_s+ ']:radio").change(function() {'
# html += 'var response_score = jQuery("#responses_' +count.to_s+ '_score");'
# html += 'var checked_value = jQuery("input[name=Radio_' +self.id.to_s+ ']:checked").val();'
# html += 'response_score.val(checked_value);});</script>'
#
# # if !self.max_label.nil?
# # html += '<td width="10%">' +self.max_label+ '</td>'
# # else
# # html += '<td width="10%"></td>'
# # end
# ## code added to remove duplicated code
# html = complete_max_label_condition(self, html)
#
# html += '<td width="10%"></td></tr></table>'
# html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
# html += answer.comments if !answer.nil?
# html += '</textarea><br/><br/>'

## code added to reduce Cyclomatic Complexity
html = complete_scale(self, html, count, answer, questionnaire_min, questionnaire_max)
end
html.html_safe
end

3. Identical code found in 1 other location: Line 20 - 32 (mass = 89)
Also found in app/models/scale.rb:17…28
The following method is removed from subclass: criterion and added to their superclass: scaled_question
def view_question_text

def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end

html += '</TR>'
Html.html_safe
end

4. Identical code found in 1 other location: Line 135 - 139 (mass = 50)
Also found in app/models/scale.rb:50…54
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end

5. Identical code found in 1 other location Line 13 - 14 (mass = 40)
Also found in app/models/scale.rb:10…11
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end

6. Similar code found in 1 other location Line 103 - 105 (mass = 26)
Also found in app/models/criterion.rb:107…110
Wrap the duplicated code into an instance method

def complete_drop_down_label_config(html, label)
html += j.to_s
html += "-" + label if label && label.length>0
html += "</option>"
end

7. Similar code found in 2 other locations Line 152 - 153 (mass = 22)
Also found in app/models/criterion.rb:115…116
app/models/text_area.rb:12…13
Wrap the duplicated code into an instance method

def complete_answer_comment(count, html, answer)
html += '<textarea cols=' +cols+ ' rows=' +rows+ ' id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" style="overflow:hidden;">'
html += answer.comments if !answer.nil?
end

8. Similar code found in 3 other locations: Line 130 - 134 (mass = 18)
Also found in app/models/criterion.rb:145…149
app/models/scale.rb:45…49
app/models/scale.rb:60…64
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question

# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end

Scale.rb
Cyclomatic complexity for complete is too high. Method has too many lines
def complete(count, answer=nil, questionnaire_min, questionnaire_max)

def complete(count, answer=nil, questionnaire_min, questionnaire_max)
html = self.txt + '<br>'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += 'value="'+answer.answer.to_s+'"' if !answer.nil?
html += '>'
html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'

html += '<table>'
html += '<tr><td width="10%"></td>'
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><label>' +j.to_s+ '</label></td>'
end
html += '<td width="10%"></td></tr><tr>'

# Identical code found in 1 other location, replaced with a method
# if !self.min_label.nil?
# html += '<td width="10%">' +self.min_label+ '</td>'
# else
# html += '<td width="10%"></td>'
# end
html = complete_label(self.min_label, html)

# comment by Hui, replaced with a method
# for j in questionnaire_min..questionnaire_max
# html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +self.id.to_s+ '"'
# html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
# html += '></td>'
# end
html = complete_questionnaire_min_to_questionnaire_max(self, html, answer, questionnaire_min, questionnaire_max)

html += '<script>jQuery("input[name=Radio_' +self.id.to_s+ ']:radio").change(function() {'
html += 'var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'var checked_value = jQuery("input[name=Radio_' +self.id.to_s+ ']:checked").val();'
html += 'response_score.val(checked_value);});</script>'

# comment by Hui, replaced with a method
# if !self.max_label.nil?
# html += '<td width="10%">' +self.max_label+ '</td>'
# else
# html += '<td width="10%"></td>'
# end
html = complete_label(self.max_label, html)

html += '<td width="10%"></td></tr></table>'
html.html_safe
end

Identical code found in 1 other location: line 17-28
app/models/criterion.rb:20…32
def view_question_text
The following method is removed from subclass: scale and added to their superclass: scaled_question

#This method returns what to display if an instructor (etc.) is viewing a questionnaire
def view_question_text
html = '<TR><TD align="left"> '+self.txt+' </TD>'
html += '<TD align="left">'+self.type+'</TD>'
html += '<td align="center">'+self.weight.to_s+'</TD>'
questionnaire = self.questionnaire
if !self.max_label.nil? && !self.min_label.nil?
html += '<TD align="center"> ('+self.min_label+') '+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + ' ('+self.max_label+')</TD>'
else
html += '<TD align="center">'+questionnaire.min_question_score.to_s+' to '+ questionnaire.max_question_score.to_s + '</TD>'
end
html += '</TR>'
html.html_safe
end

Identical code found in 1 other location: line 50-54
app/models/criterion.rb:135…139
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question

# add the following functions to refactor duplicates.
def complete_questionnaire_min_to_questionnaire_max(ob, html, answer, questionnaire_min, questionnaire_max)
for j in questionnaire_min..questionnaire_max
html += '<td width="10%"><input type="radio" id="' +j.to_s+ '" value="' +j.to_s+ '" name="Radio_' +ob.id.to_s+ '"'
html += 'checked="checked"' if (!answer.nil? and answer.answer == j) or (answer.nil? and questionnaire_min == j)
html += '></td>'
end
return html
end

Identical code found in 1 other location: line 10-11
app/models/criterion.rb:13…14
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question
# add the following functions to refactor duplicates.
def edit_end(ob, html)
html+='<td> max_label <input size="4" value="'+ob.max_label.to_s+'" name="question['+ob.id.to_s+'][max_label]" id="question_'+ob.id.to_s+'_max_label" type="text"> min_label <input size="4" value="'+ob.min_label.to_s+'" name="question['+ob.id.to_s+'][min_label]" id="question_'+ob.id.to_s+'_min_label" type="text"></td>'
html+='</tr>'
end

Similar code found in 3 other locations: line 60-64
app/models/criterion.rb:130…134
app/models/criterion.rb:145…149
app/models/scale.rb:45…49
Wrap the duplicated code into an instance method and add the instance method into superclass: scaled_question

# add the following functions to refactor duplicates.
def complete_label(label, html)
if !label.nil?
html += '<td width="10%">' +label+ '</td>'
else
html += '<td width="10%"></td>'
end
end

Checkbox.rb
Method has too many lines.
By moving codes to private methods outside this method, this problem can be fixed together with the following one. Here is the new complete method together with two additional private methods: hasAnswer(html, answer) and nextQuestionTail(html, next_question). The source codes are listed as below.

def complete(count, answer=nil)
curr_question = Question.find(self.id)
prev_question = Question.where("seq < ?", curr_question.seq).order(:seq).last
next_question = Question.where("seq > ?", curr_question.seq).order(:seq).first
html = ''
if prev_question.type == 'ColumnHeader'
html = '<td style="padding: 15px;">'
#else
# html = ''
end

html += '<input id="responses_' +count.to_s+ '_comments" name="responses[' +count.to_s+ '][comment]" type="hidden" value="">'
html += '<input id="responses_' +count.to_s+ '_score" name="responses[' +count.to_s+ '][score]" type="hidden"'
html += hasAnswer(html , answer)
# if !answer.nil? and answer.answer == 1
# html += 'value="1"'
# else
# html += 'value="0"'
# end
html += '>'
html += '<input id="responses_' +count.to_s+ '_checkbox" type="checkbox" onchange="checkbox' +count.to_s+ 'Changed()"'
html += 'checked="checked"' if !answer.nil? and answer.answer == 1
html += '>'
html += '<label for="responses_' +count.to_s+ '">' +self.txt+ '</label>'

html += '<script>function checkbox' +count.to_s+ 'Changed() {'
html += ' var checkbox = jQuery("#responses_' +count.to_s+ '_checkbox");'
html += ' var response_score = jQuery("#responses_' +count.to_s+ '_score");'
html += 'if (checkbox.is(":checked")) {'
html += 'response_score.val("1");'
html += '} else {'
html += 'response_score.val("0");}}</script>'

html = nextQuestionTail(html, next_question)
# if next_question.type == 'ColumnHeader'
# html += '</td></tr>'
# elsif next_question.type == 'SectionHeader' or next_question.type == 'TableHeader'
# html += '</td></tr></table><br/>'
# else
# html += '<BR/>'
# end
html.html_safe
end

#YJ private for complete()
def hasAnswer(html, answer)
if !answer.nil? and answer.answer == 1
html += 'value="1"'
else
html += 'value="0"'
end
return html
end

def nextQuestionTail(html, next_q)
if next_question.type == 'ColumnHeader'
html += '</td></tr>'
elsif next_question.type == 'SectionHeader' or next_question.type == 'TableHeader'
html += '</td></tr></table><br/>'
else
html += '<BR/>'
end
return html
end

Cyclomatic complexity for complete is too high.
This problem can be solved by moving branches outside to other private methods. See source code above.
Similar codes in edit method are found in 2 other locations.
(questionnaire_header.rb and upload_file.rb)
Such code duplication can be eliminated by moving the identical part of the similar edit method to a new function, named edit_prefix(html, count) to their common superclass, which is Question (question.rb).
Here is the source code of the added edit_prefix method in question.rb:

def edit_prefix(ob, html)
html ='<tr>'
html+='<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' +ob.id.to_s+ '">Remove</a></td>'
html+='<td><input size="6" value="'+ob.seq.to_s+'" name="question['+ob.id.to_s+'][seq]" id="question_'+ob.id.to_s+'_seq" type="text"></td>'
html+='<td><textarea cols="50" rows="1" name="question['+ob.id.to_s+'][txt]" id="question_'+ob.id.to_s+'_txt">'+ob.txt+'</textarea></td>'
html+='<td><input size="10" disabled="disabled" value="'+ob.type+'" name="question['+ob.id.to_s+'][type]" id="question_'+ob.id.to_s+'_type" type="text">''</td>'
end
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:

def edit(count)
html = edit_prefix(self, html)
# html ='<tr>'
# html+='<td align="center"><a rel="nofollow" data-method="delete" href="/questions/' +self.id.to_s+ '">Remove</a></td>'
# html+='<td><input size="6" value="'+self.seq.to_s+'" name="question['+self.id.to_s+'][seq]" id="question_'+self.id.to_s+'_seq" type="text"></td>'
# html+='<td><textarea cols="50" rows="1" name="question['+self.id.to_s+'][txt]" id="question_'+self.id.to_s+'_txt">'+self.txt+'</textarea></td>'
# html+='<td><input size="10" disabled="disabled" value="'+self.type+'" name="question['+self.id.to_s+'][type]" id="question_'+self.id.to_s+'_type" type="text">''</td>'
html+='<td></td>'
html+='</tr>'

html.html_safe
end

Similar codes in view_question_text method are found in 4 other locations.
(dropdown.rb, questionnaire_header.rb, text_response.rb, upload_file.rb)
The solution to this problem is the same as above one, below is the function added in the most common superclass, which is Question, that contains the common parts of the codes found in the view_question_text methods in all five classes.
def view_qt_prefix(ob, html)
html = '<TR><TD align="left"> '+ob.txt+ ' </TD>'
html += '<TD align="left">'+ob.type+'</TD>'
html += '<td align="center">'+ob.weight.to_s+'</TD>'
end
The original code are commented out and insert the function call of the above function, html will be returned in the above function, see codes below:

def view_question_text
html = view_qt_prefix(ob, html)
# html = '<TR><TD align="left"> '+self.txt+' </TD>'
# html += '<TD align="left">'+self.type+'</TD>'
# html += '<td align="center">'+self.weight.to_s+'</TD>'
html += '<TD align="center">Checked/Unchecked</TD>'
html += '</TR>'
html.html_safe
end

Questionnaire_header.rb
All problems in this file are solved after solving the problems found in checkbox.rb.
Upload_file.rb
All problems in this file are solved after solving the problems found in checkbox.rb.
Unit-test
Criterion.rb
Scale.rb
Checkbox.rb
Questionnaire_header.rb
Upload_file.rb